Note: There is a newer version (2.0.2) of this package available. Click here to view docs for the latest version.
Module jira
ballerinax/jira Ballerina library
2.0.1
Overview
Jira is a powerful project management and issue tracking platform developed by Atlassian, widely used for agile software development, bug tracking, and workflow management.
The ballerinax/jira package provides APIs to connect and interact with Jira’s REST API endpoints, enabling seamless integration for operations such as managing issues, projects, users, and workflows. The latest version corresponds to the REST API version 3 (Cloud), which builds upon v2 with additional support such as Atlassian Document Format (ADF) in fields like comments and descriptions.
Setup guide
To use the Jira connector, you must have access to the Atlassian API through your Atlassian account. To access premium features, a Premium subscription is required. If you do not have an account, you can sign up for one here.
Step 1: Create an Atlassian account
- Sign up for an account or log in to your Atlassian account
- You will be redirected after a successful login.
Step 2: Create API token
- Click on account settings
- Click on security tab
- Click on Create and manage API tokens
- Create API token
- Store the access token securely for use in your application.
Quickstart
To use the Jira connector in your Ballerina application, update the .bal file as follows:
Step 1: Import the module
Import the jira module.
import ballerinax/jira;
Step 2: Instantiate a new connector
- Create a
Config.tomlfile and, configure the obtained credentials in the above steps as follows:
username = "<your email>" password = "<Access Token>"
- Create a jira:ConnectionConfig with the obtained access token and initialize the connector with it.
configurable string username = ?; configurable string password = ?; jira:ConnectionConfig config = { auth: { username, password } }; final jira:Client jiraClient = check new(config,<"your-organization-id.atlassian.net/rest">);
Step 3: Invoke the connector operation
Get the user
public function main() returns error? { jira:User user = check jiraClient->/api/'3/myself; }
Step 4: Run the Ballerina application
bal run
Examples
The Jira connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:
- Create Project and Issue - Creates a new Jira project and adds an issue to it.
- Create Issue and Add Comment - Creates a new issue in an existing Jira project and adds a comment to it.
Clients
jira: Client
Isolated
Jira Cloud platform REST API documentation
Constructor
Gets invoked to initialize the connector.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://your-domain.atlassian.net/rest" - URL of the target service
get api/'3/announcementBanner
Isolated FunctionResource Function
function get api/'3/announcementBanner(map<string|string[]> headers) returns AnnouncementBannerConfiguration|errorGet announcement banner configuration
Return Type
- AnnouncementBannerConfiguration|error - Returned if the request is successful
put api/'3/announcementBanner
Isolated FunctionResource Function
function put api/'3/announcementBanner(AnnouncementBannerConfigurationUpdate payload, map<string|string[]> headers) returns json|errorUpdate announcement banner configuration
Parameters
- payload AnnouncementBannerConfigurationUpdate -
Return Type
- json|error - Returned if the request is successful
post api/'3/app/'field/context/configuration/list
Isolated FunctionResource Function
function post api/'3/app/'field/context/configuration/list(ConfigurationsListParameters payload, map<string|string[]> headers, *GetCustomFieldsConfigurationsQueries queries) returns PageBeanBulkContextualConfiguration|errorBulk get custom field configurations
Parameters
- payload ConfigurationsListParameters -
- queries *GetCustomFieldsConfigurationsQueries - Queries to be sent with the request
Return Type
- PageBeanBulkContextualConfiguration|error - Returned if the request is successful
post api/'3/app/'field/value
Isolated FunctionResource Function
function post api/'3/app/'field/value(MultipleCustomFieldValuesUpdateDetails payload, map<string|string[]> headers, *UpdateMultipleCustomFieldValuesQueries queries) returns json|errorUpdate custom fields
Parameters
- payload MultipleCustomFieldValuesUpdateDetails -
- queries *UpdateMultipleCustomFieldValuesQueries - Queries to be sent with the request
Return Type
- json|error - Returned if the request is successful
get api/'3/app/'field/[string fieldIdOrKey]/context/configuration
Isolated FunctionResource Function
function get api/'3/app/'field/[string fieldIdOrKey]/context/configuration(map<string|string[]> headers, *GetCustomFieldConfigurationQueries queries) returns PageBeanContextualConfiguration|errorGet custom field configurations
Parameters
- queries *GetCustomFieldConfigurationQueries - Queries to be sent with the request
Return Type
- PageBeanContextualConfiguration|error - Returned if the request is successful
put api/'3/app/'field/[string fieldIdOrKey]/context/configuration
Isolated FunctionResource Function
function put api/'3/app/'field/[string fieldIdOrKey]/context/configuration(CustomFieldConfigurations payload, map<string|string[]> headers) returns json|errorUpdate custom field configurations
Parameters
- payload CustomFieldConfigurations -
Return Type
- json|error - Returned if the request is successful
put api/'3/app/'field/[string fieldIdOrKey]/value
Isolated FunctionResource Function
function put api/'3/app/'field/[string fieldIdOrKey]/value(CustomFieldValueUpdateDetails payload, map<string|string[]> headers, *UpdateCustomFieldValueQueries queries) returns json|errorUpdate custom field value
Parameters
- payload CustomFieldValueUpdateDetails -
- queries *UpdateCustomFieldValueQueries - Queries to be sent with the request
Return Type
- json|error - Returned if the request is successful
get api/'3/application-properties
Isolated FunctionResource Function
function get api/'3/application\-properties(map<string|string[]> headers, *GetApplicationPropertyQueries queries) returns ApplicationProperty[]|errorGet application property
Parameters
- queries *GetApplicationPropertyQueries - Queries to be sent with the request
Return Type
- ApplicationProperty[]|error - Returned if the request is successful
get api/'3/application-properties/advanced-settings
Isolated FunctionResource Function
function get api/'3/application\-properties/advanced\-settings(map<string|string[]> headers) returns ApplicationProperty[]|errorGet advanced settings
Return Type
- ApplicationProperty[]|error - Returned if the request is successful
put api/'3/application-properties/[string id]
Isolated FunctionResource Function
function put api/'3/application\-properties/[string id](SimpleApplicationPropertyBean payload, map<string|string[]> headers) returns ApplicationProperty|errorSet application property
Parameters
- payload SimpleApplicationPropertyBean -
Return Type
- ApplicationProperty|error - Returned if the request is successful
get api/'3/applicationrole
Isolated FunctionResource Function
function get api/'3/applicationrole(map<string|string[]> headers) returns ApplicationRole[]|errorGet all application roles
Return Type
- ApplicationRole[]|error - Returned if the request is successful
get api/'3/applicationrole/[string 'key]
Isolated FunctionResource Function
function get api/'3/applicationrole/[string 'key](map<string|string[]> headers) returns ApplicationRole|errorGet application role
Return Type
- ApplicationRole|error - Returned if the request is successful
get api/'3/attachment/content/[string id]
Isolated FunctionResource Function
function get api/'3/attachment/content/[string id](map<string|string[]> headers, *GetAttachmentContentQueries queries) returns anydata[]|error?Get attachment content
Parameters
- queries *GetAttachmentContentQueries - Queries to be sent with the request
Return Type
- anydata[]|error? - Returned if the request is successful when
redirectis set tofalse
get api/'3/attachment/meta
Isolated FunctionResource Function
function get api/'3/attachment/meta(map<string|string[]> headers) returns AttachmentSettings|errorGet Jira attachment settings
Return Type
- AttachmentSettings|error - Returned if the request is successful
get api/'3/attachment/thumbnail/[string id]
Isolated FunctionResource Function
function get api/'3/attachment/thumbnail/[string id](map<string|string[]> headers, *GetAttachmentThumbnailQueries queries) returns anydata[]|error?Get attachment thumbnail
Parameters
- queries *GetAttachmentThumbnailQueries - Queries to be sent with the request
Return Type
- anydata[]|error? - Returned if the request is successful when
redirectis set tofalse
get api/'3/attachment/[string id]
Isolated FunctionResource Function
function get api/'3/attachment/[string id](map<string|string[]> headers) returns AttachmentMetadata|errorGet attachment metadata
Return Type
- AttachmentMetadata|error - Returned if the request is successful
delete api/'3/attachment/[string id]
Isolated FunctionResource Function
Delete attachment
Return Type
- error? - Returned if the request is successful
get api/'3/attachment/[string id]/expand/human
Isolated FunctionResource Function
function get api/'3/attachment/[string id]/expand/human(map<string|string[]> headers) returns AttachmentArchiveMetadataReadable|errorGet all metadata for an expanded 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
get api/'3/attachment/[string id]/expand/raw
Isolated FunctionResource Function
function get api/'3/attachment/[string id]/expand/raw(map<string|string[]> headers) returns AttachmentArchiveImpl|errorGet contents metadata for an expanded 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
get api/'3/auditing/'record
Isolated FunctionResource Function
function get api/'3/auditing/'record(map<string|string[]> headers, *GetAuditRecordsQueries queries) returns AuditRecords|errorGet audit records
Parameters
- queries *GetAuditRecordsQueries - Queries to be sent with the request
Return Type
- AuditRecords|error - Returned if the request is successful
get api/'3/avatar/["issuetype"|"project"|"user"|"priority" 'type]/system
Isolated FunctionResource Function
function get api/'3/avatar/["issuetype"|"project"|"user"|"priority" 'type]/system(map<string|string[]> headers) returns SystemAvatars|errorGet system avatars by type
Return Type
- SystemAvatars|error - Returned if the request is successful
post api/'3/bulk/issues/delete
Isolated FunctionResource Function
function post api/'3/bulk/issues/delete(IssueBulkDeletePayload payload, map<string|string[]> headers) returns SubmittedBulkOperation|errorBulk delete issues
Parameters
- payload IssueBulkDeletePayload - The request body containing the issues to be deleted
Return Type
- SubmittedBulkOperation|error - Returned if the request is successful
get api/'3/bulk/issues/fields
Isolated FunctionResource Function
function get api/'3/bulk/issues/fields(map<string|string[]> headers, *GetBulkEditableFieldsQueries queries) returns BulkEditGetFields|errorGet bulk editable fields
Parameters
- queries *GetBulkEditableFieldsQueries - Queries to be sent with the request
Return Type
- BulkEditGetFields|error - Returned if the request is successful
post api/'3/bulk/issues/fields
Isolated FunctionResource Function
function post api/'3/bulk/issues/fields(IssueBulkEditPayload payload, map<string|string[]> headers) returns SubmittedBulkOperation|errorBulk edit issues
Parameters
- payload IssueBulkEditPayload - The request body containing the issues to be edited and the new field values
Return Type
- SubmittedBulkOperation|error - Returned if the request is successful
post api/'3/bulk/issues/move
Isolated FunctionResource Function
function post api/'3/bulk/issues/move(IssueBulkMovePayload payload, map<string|string[]> headers) returns SubmittedBulkOperation|errorBulk move issues
Parameters
- payload IssueBulkMovePayload -
Return Type
- SubmittedBulkOperation|error - Returned if the request is successful
get api/'3/bulk/issues/transition
Isolated FunctionResource Function
function get api/'3/bulk/issues/transition(map<string|string[]> headers, *GetAvailableTransitionsQueries queries) returns BulkTransitionGetAvailableTransitions|errorGet available transitions
Parameters
- queries *GetAvailableTransitionsQueries - Queries to be sent with the request
Return Type
- BulkTransitionGetAvailableTransitions|error - Returned if the request is successful
post api/'3/bulk/issues/transition
Isolated FunctionResource Function
function post api/'3/bulk/issues/transition(IssueBulkTransitionPayload payload, map<string|string[]> headers) returns SubmittedBulkOperation|errorBulk transition issue statuses
Parameters
- payload IssueBulkTransitionPayload - The request body containing the issues to be transitioned
Return Type
- SubmittedBulkOperation|error - Returned if the request is successful
post api/'3/bulk/issues/unwatch
Isolated FunctionResource Function
function post api/'3/bulk/issues/unwatch(IssueBulkWatchOrUnwatchPayload payload, map<string|string[]> headers) returns SubmittedBulkOperation|errorBulk unwatch issues
Parameters
- payload IssueBulkWatchOrUnwatchPayload - The request body containing the issues to be unwatched
Return Type
- SubmittedBulkOperation|error - Returned if the request is successful
post api/'3/bulk/issues/watch
Isolated FunctionResource Function
function post api/'3/bulk/issues/watch(IssueBulkWatchOrUnwatchPayload payload, map<string|string[]> headers) returns SubmittedBulkOperation|errorBulk watch issues
Parameters
- payload IssueBulkWatchOrUnwatchPayload - The request body containing the issues to be watched
Return Type
- SubmittedBulkOperation|error - Returned if the request is successful
get api/'3/bulk/queue/[string taskId]
Isolated FunctionResource Function
function get api/'3/bulk/queue/[string taskId](map<string|string[]> headers) returns BulkOperationProgress|errorGet bulk issue operation progress
Return Type
- BulkOperationProgress|error - Returned if the request is successful
post api/'3/changelog/bulkfetch
Isolated FunctionResource Function
function post api/'3/changelog/bulkfetch(BulkChangelogRequestBean payload, map<string|string[]> headers) returns BulkChangelogResponseBean|errorBulk fetch changelogs
Parameters
- payload BulkChangelogRequestBean - A JSON object containing the bulk fetch changelog request filters such as issue IDs and field IDs
Return Type
- BulkChangelogResponseBean|error - Returned if the request is successful
get api/'3/classification-levels
Isolated FunctionResource Function
function get api/'3/classification\-levels(map<string|string[]> headers, *GetAllUserDataClassificationLevelsQueries queries) returns DataClassificationLevelsBean|errorGet all classification levels
Parameters
- queries *GetAllUserDataClassificationLevelsQueries - Queries to be sent with the request
Return Type
- DataClassificationLevelsBean|error - Returned if the request is successful
post api/'3/comment/list
Isolated FunctionResource Function
function post api/'3/comment/list(IssueCommentListRequestBean payload, map<string|string[]> headers, *GetCommentsByIdsQueries queries) returns PageBeanComment|errorGet comments by IDs
Parameters
- payload IssueCommentListRequestBean - The list of comment IDs
- queries *GetCommentsByIdsQueries - Queries to be sent with the request
Return Type
- PageBeanComment|error - Returned if the request is successful
get api/'3/comment/[string commentId]/properties
Isolated FunctionResource Function
function get api/'3/comment/[string commentId]/properties(map<string|string[]> headers) returns PropertyKeys|errorGet comment property keys
Return Type
- PropertyKeys|error - Returned if the request is successful
get api/'3/comment/[string commentId]/properties/[string propertyKey]
Isolated FunctionResource Function
function get api/'3/comment/[string commentId]/properties/[string propertyKey](map<string|string[]> headers) returns EntityProperty|errorGet comment property
Return Type
- EntityProperty|error - Returned if the request is successful
put api/'3/comment/[string commentId]/properties/[string propertyKey]
Isolated FunctionResource Function
function put api/'3/comment/[string commentId]/properties/[string propertyKey](json payload, map<string|string[]> headers) returns json|errorSet comment property
Parameters
- payload json - The value of the property. The value has to be a valid, non-empty JSON value. The maximum length of the property value is 32768 bytes
Return Type
- json|error - Returned if the comment property is updated
delete api/'3/comment/[string commentId]/properties/[string propertyKey]
Isolated FunctionResource Function
function delete api/'3/comment/[string commentId]/properties/[string propertyKey](map<string|string[]> headers) returns error?Delete comment property
Return Type
- error? - Returned if the request is successful
get api/'3/component
Isolated FunctionResource Function
function get api/'3/component(map<string|string[]> headers, *FindComponentsForProjectsQueries queries) returns PageBean2ComponentJsonBean|errorFind components for projects
Parameters
- queries *FindComponentsForProjectsQueries - Queries to be sent with the request
Return Type
- PageBean2ComponentJsonBean|error - Returned if the request is successful
post api/'3/component
Isolated FunctionResource Function
function post api/'3/component(ProjectComponent payload, map<string|string[]> headers) returns ProjectComponent|errorCreate component
Parameters
- payload ProjectComponent -
Return Type
- ProjectComponent|error - Returned if the request is successful
get api/'3/component/[string id]
Isolated FunctionResource Function
function get api/'3/component/[string id](map<string|string[]> headers) returns ProjectComponent|errorGet component
Return Type
- ProjectComponent|error - Returned if the request is successful
put api/'3/component/[string id]
Isolated FunctionResource Function
function put api/'3/component/[string id](ProjectComponent payload, map<string|string[]> headers) returns ProjectComponent|errorUpdate component
Parameters
- payload ProjectComponent -
Return Type
- ProjectComponent|error - Returned if the request is successful
delete api/'3/component/[string id]
Isolated FunctionResource Function
function delete api/'3/component/[string id](map<string|string[]> headers, *DeleteComponentQueries queries) returns error?Delete component
Parameters
- queries *DeleteComponentQueries - Queries to be sent with the request
Return Type
- error? - Returned if the request is successful
get api/'3/component/[string id]/relatedIssueCounts
Isolated FunctionResource Function
function get api/'3/component/[string id]/relatedIssueCounts(map<string|string[]> headers) returns ComponentIssuesCount|errorGet component issues count
Return Type
- ComponentIssuesCount|error - Returned if the request is successful
get api/'3/configuration
Isolated FunctionResource Function
function get api/'3/configuration(map<string|string[]> headers) returns Configuration|errorGet global settings
Return Type
- Configuration|error - Returned if the request is successful
get api/'3/configuration/timetracking
Isolated FunctionResource Function
function get api/'3/configuration/timetracking(map<string|string[]> headers) returns TimeTrackingProvider|json|errorGet selected time tracking provider
Return Type
- TimeTrackingProvider|json|error - Returned if the request is successful and time tracking is enabled
put api/'3/configuration/timetracking
Isolated FunctionResource Function
function put api/'3/configuration/timetracking(TimeTrackingProvider payload, map<string|string[]> headers) returns json|errorSelect time tracking provider
Parameters
- payload TimeTrackingProvider -
Return Type
- json|error - Returned if the request is successful
get api/'3/configuration/timetracking/list
Isolated FunctionResource Function
function get api/'3/configuration/timetracking/list(map<string|string[]> headers) returns TimeTrackingProvider[]|errorGet all time tracking providers
Return Type
- TimeTrackingProvider[]|error - Returned if the request is successful
get api/'3/configuration/timetracking/options
Isolated FunctionResource Function
function get api/'3/configuration/timetracking/options(map<string|string[]> headers) returns TimeTrackingConfiguration|errorGet time tracking settings
Return Type
- TimeTrackingConfiguration|error - Returned if the request is successful
put api/'3/configuration/timetracking/options
Isolated FunctionResource Function
function put api/'3/configuration/timetracking/options(TimeTrackingConfiguration payload, map<string|string[]> headers) returns TimeTrackingConfiguration|errorSet time tracking settings
Parameters
- payload TimeTrackingConfiguration -
Return Type
- TimeTrackingConfiguration|error - Returned if the request is successful
get api/'3/customFieldOption/[string id]
Isolated FunctionResource Function
function get api/'3/customFieldOption/[string id](map<string|string[]> headers) returns CustomFieldOption|errorGet custom field option
Return Type
- CustomFieldOption|error - Returned if the request is successful
get api/'3/dashboard
Isolated FunctionResource Function
function get api/'3/dashboard(map<string|string[]> headers, *GetAllDashboardsQueries queries) returns PageOfDashboards|errorGet all dashboards
Parameters
- queries *GetAllDashboardsQueries - Queries to be sent with the request
Return Type
- PageOfDashboards|error - Returned if the request is successful
post api/'3/dashboard
Isolated FunctionResource Function
function post api/'3/dashboard(DashboardDetails payload, map<string|string[]> headers, *CreateDashboardQueries queries) returns Dashboard|errorCreate dashboard
Parameters
- payload DashboardDetails - Dashboard details
- queries *CreateDashboardQueries - Queries to be sent with the request
put api/'3/dashboard/bulk/edit
Isolated FunctionResource Function
function put api/'3/dashboard/bulk/edit(BulkEditShareableEntityRequest payload, map<string|string[]> headers) returns BulkEditShareableEntityResponse|errorBulk edit dashboards
Parameters
- payload BulkEditShareableEntityRequest - The details of dashboards being updated in bulk
Return Type
- BulkEditShareableEntityResponse|error - Returned if the request is successful
get api/'3/dashboard/gadgets
Isolated FunctionResource Function
function get api/'3/dashboard/gadgets(map<string|string[]> headers) returns AvailableDashboardGadgetsResponse|errorGet available gadgets
Return Type
- AvailableDashboardGadgetsResponse|error - Returned if the request is successful
get api/'3/dashboard/search
Isolated FunctionResource Function
function get api/'3/dashboard/search(map<string|string[]> headers, *GetDashboardsPaginatedQueries queries) returns PageBeanDashboard|errorSearch for dashboards
Parameters
- queries *GetDashboardsPaginatedQueries - Queries to be sent with the request
Return Type
- PageBeanDashboard|error - Returned if the request is successful
get api/'3/dashboard/[int dashboardId]/gadget
Isolated FunctionResource Function
function get api/'3/dashboard/[int dashboardId]/gadget(map<string|string[]> headers, *GetAllGadgetsQueries queries) returns DashboardGadgetResponse|errorGet gadgets
Parameters
- queries *GetAllGadgetsQueries - Queries to be sent with the request
Return Type
- DashboardGadgetResponse|error - Returned if the request is successful
post api/'3/dashboard/[int dashboardId]/gadget
Isolated FunctionResource Function
function post api/'3/dashboard/[int dashboardId]/gadget(DashboardGadgetSettings payload, map<string|string[]> headers) returns DashboardGadget|errorAdd gadget to dashboard
Parameters
- payload DashboardGadgetSettings -
Return Type
- DashboardGadget|error - Returned if the request is successful
put api/'3/dashboard/[int dashboardId]/gadget/[int gadgetId]
Isolated FunctionResource Function
function put api/'3/dashboard/[int dashboardId]/gadget/[int gadgetId](DashboardGadgetUpdateRequest payload, map<string|string[]> headers) returns json|errorUpdate gadget on dashboard
Parameters
- payload DashboardGadgetUpdateRequest -
Return Type
- json|error - Returned if the request is successful
delete api/'3/dashboard/[int dashboardId]/gadget/[int gadgetId]
Isolated FunctionResource Function
function delete api/'3/dashboard/[int dashboardId]/gadget/[int gadgetId](map<string|string[]> headers) returns json|errorRemove gadget from dashboard
Return Type
- json|error - Returned if the request is successful
get api/'3/dashboard/[string dashboardId]/items/[string itemId]/properties
Isolated FunctionResource Function
function get api/'3/dashboard/[string dashboardId]/items/[string itemId]/properties(map<string|string[]> headers) returns PropertyKeys|errorGet dashboard item property keys
Return Type
- PropertyKeys|error - Returned if the request is successful
get api/'3/dashboard/[string dashboardId]/items/[string itemId]/properties/[string propertyKey]
Isolated FunctionResource Function
function get api/'3/dashboard/[string dashboardId]/items/[string itemId]/properties/[string propertyKey](map<string|string[]> headers) returns EntityProperty|errorGet dashboard item property
Return Type
- EntityProperty|error - Returned if the request is successful
put api/'3/dashboard/[string dashboardId]/items/[string itemId]/properties/[string propertyKey]
Isolated FunctionResource Function
function put api/'3/dashboard/[string dashboardId]/items/[string itemId]/properties/[string propertyKey](json payload, map<string|string[]> headers) returns json|errorSet dashboard item property
Parameters
- payload json - The value of the property. The value has to be a valid, non-empty JSON value. The maximum length of the property value is 32768 bytes
Return Type
- json|error - Returned if the dashboard item property is updated
delete api/'3/dashboard/[string dashboardId]/items/[string itemId]/properties/[string propertyKey]
Isolated FunctionResource Function
function delete api/'3/dashboard/[string dashboardId]/items/[string itemId]/properties/[string propertyKey](map<string|string[]> headers) returns json|errorDelete dashboard item property
Return Type
- json|error - Returned if the dashboard item property is deleted
get api/'3/dashboard/[string id]
Isolated FunctionResource Function
Get dashboard
put api/'3/dashboard/[string id]
Isolated FunctionResource Function
function put api/'3/dashboard/[string id](DashboardDetails payload, map<string|string[]> headers, *UpdateDashboardQueries queries) returns Dashboard|errorUpdate dashboard
Parameters
- payload DashboardDetails - Replacement dashboard details
- queries *UpdateDashboardQueries - Queries to be sent with the request
delete api/'3/dashboard/[string id]
Isolated FunctionResource Function
Delete dashboard
Return Type
- error? - Returned if the dashboard is deleted
post api/'3/dashboard/[string id]/copy
Isolated FunctionResource Function
function post api/'3/dashboard/[string id]/copy(DashboardDetails payload, map<string|string[]> headers, *CopyDashboardQueries queries) returns Dashboard|errorCopy dashboard
Parameters
- payload DashboardDetails - Dashboard details
- queries *CopyDashboardQueries - Queries to be sent with the request
get api/'3/data-policy
Isolated FunctionResource Function
function get api/'3/data\-policy(map<string|string[]> headers) returns WorkspaceDataPolicy|errorGet data policy for the workspace
Return Type
- WorkspaceDataPolicy|error - Returned if the request is successful
get api/'3/data-policy/project
Isolated FunctionResource Function
function get api/'3/data\-policy/project(map<string|string[]> headers, *GetPoliciesQueries queries) returns ProjectDataPolicies|errorGet data policy for projects
Parameters
- queries *GetPoliciesQueries - Queries to be sent with the request
Return Type
- ProjectDataPolicies|error - Returned if the request is successful
get api/'3/events
Isolated FunctionResource Function
function get api/'3/events(map<string|string[]> headers) returns IssueEvent[]|errorGet events
Return Type
- IssueEvent[]|error - Returned if the request is successful
post api/'3/expression/analyse
Isolated FunctionResource Function
function post api/'3/expression/analyse(JiraExpressionForAnalysis payload, map<string|string[]> headers, *AnalyseExpressionQueries queries) returns JiraExpressionsAnalysis|errorAnalyse Jira expression
Parameters
- payload JiraExpressionForAnalysis - The Jira expressions to analyse
- queries *AnalyseExpressionQueries - Queries to be sent with the request
Return Type
- JiraExpressionsAnalysis|error - Returned if the request is successful
post api/'3/expression/eval
DeprecatedIsolated FunctionResource Function
function post api/'3/expression/eval(JiraExpressionEvalRequestBean payload, map<string|string[]> headers, *EvaluateJiraExpressionQueries queries) returns JiraExpressionResult|errorCurrently being removed. Evaluate Jira expression
Parameters
- payload JiraExpressionEvalRequestBean - The Jira expression and the evaluation context
- queries *EvaluateJiraExpressionQueries - Queries to be sent with the request
Return Type
- JiraExpressionResult|error - Returned if the evaluation results in a value. The result is a JSON primitive value, list, or object
Deprecated
post api/'3/expression/evaluate
Isolated FunctionResource Function
function post api/'3/expression/evaluate(JiraExpressionEvaluateRequestBean payload, map<string|string[]> headers, *EvaluateJSISJiraExpressionQueries queries) returns JExpEvaluateJiraExpressionResultBean|errorEvaluate Jira expression using enhanced search API
Parameters
- payload JiraExpressionEvaluateRequestBean - The Jira expression and the evaluation context
- queries *EvaluateJSISJiraExpressionQueries - Queries to be sent with the request
Return Type
- JExpEvaluateJiraExpressionResultBean|error - Returned if the evaluation results in a value. The result is a JSON primitive value, list, or object
get api/'3/'field
Isolated FunctionResource Function
function get api/'3/'field(map<string|string[]> headers) returns FieldDetails[]|errorGet fields
Return Type
- FieldDetails[]|error - Returned if the request is successful
post api/'3/'field
Isolated FunctionResource Function
function post api/'3/'field(CustomFieldDefinitionJsonBean payload, map<string|string[]> headers) returns FieldDetails|errorCreate custom field
Parameters
- payload CustomFieldDefinitionJsonBean - Definition of the custom field to be created
Return Type
- FieldDetails|error - Returned if the custom field is created
put api/'3/'field/association
Isolated FunctionResource Function
function put api/'3/'field/association(FieldAssociationsRequest payload, map<string|string[]> headers) returns json|errorCreate associations
Parameters
- payload FieldAssociationsRequest - Payload containing the fields to associate and the projects to associate them to
Return Type
- json|error - Returned if the field association validation passes
delete api/'3/'field/association
Isolated FunctionResource Function
function delete api/'3/'field/association(FieldAssociationsRequest payload, map<string|string[]> headers) returns json|errorRemove associations
Parameters
- payload FieldAssociationsRequest - Payload containing the fields to uassociate and the projects and issue types to unassociate them to
Return Type
- json|error - Returned if the field association validation passes
get api/'3/'field/search
Isolated FunctionResource Function
function get api/'3/'field/search(map<string|string[]> headers, *GetFieldsPaginatedQueries queries) returns PageBeanField|errorGet fields paginated
Parameters
- queries *GetFieldsPaginatedQueries - Queries to be sent with the request
Return Type
- PageBeanField|error - Returned if the request is successful
get api/'3/'field/search/trashed
Isolated FunctionResource Function
function get api/'3/'field/search/trashed(map<string|string[]> headers, *GetTrashedFieldsPaginatedQueries queries) returns PageBeanField|errorGet fields in trash paginated
Parameters
- queries *GetTrashedFieldsPaginatedQueries - Queries to be sent with the request
Return Type
- PageBeanField|error - Returned if the request is successful
put api/'3/'field/[string fieldId]
Isolated FunctionResource Function
function put api/'3/'field/[string fieldId](UpdateCustomFieldDetails payload, map<string|string[]> headers) returns json|errorUpdate custom field
Parameters
- payload UpdateCustomFieldDetails - The custom field update details
Return Type
- json|error - Returned if the request is successful
get api/'3/'field/[string fieldId]/context
Isolated FunctionResource Function
function get api/'3/'field/[string fieldId]/context(map<string|string[]> headers, *GetContextsForFieldQueries queries) returns PageBeanCustomFieldContext|errorGet custom field contexts
Parameters
- queries *GetContextsForFieldQueries - Queries to be sent with the request
Return Type
- PageBeanCustomFieldContext|error - Returned if the request is successful
post api/'3/'field/[string fieldId]/context
Isolated FunctionResource Function
function post api/'3/'field/[string fieldId]/context(CreateCustomFieldContext payload, map<string|string[]> headers) returns CreateCustomFieldContext|errorCreate custom field context
Parameters
- payload CreateCustomFieldContext -
Return Type
- CreateCustomFieldContext|error - Returned if the custom field context is created
get api/'3/'field/[string fieldId]/context/defaultValue
Isolated FunctionResource Function
function get api/'3/'field/[string fieldId]/context/defaultValue(map<string|string[]> headers, *GetDefaultValuesQueries queries) returns PageBeanCustomFieldContextDefaultValue|errorGet custom field contexts default values
Parameters
- queries *GetDefaultValuesQueries - Queries to be sent with the request
Return Type
- PageBeanCustomFieldContextDefaultValue|error - Returned if the request is successful
put api/'3/'field/[string fieldId]/context/defaultValue
Isolated FunctionResource Function
function put api/'3/'field/[string fieldId]/context/defaultValue(CustomFieldContextDefaultValueUpdate payload, map<string|string[]> headers) returns json|errorSet custom field contexts default values
Parameters
- payload CustomFieldContextDefaultValueUpdate -
Return Type
- json|error - Returned if operation is successful
get api/'3/'field/[string fieldId]/context/issuetypemapping
Isolated FunctionResource Function
function get api/'3/'field/[string fieldId]/context/issuetypemapping(map<string|string[]> headers, *GetIssueTypeMappingsForContextsQueries queries) returns PageBeanIssueTypeToContextMapping|errorGet issue types for custom field context
Parameters
- queries *GetIssueTypeMappingsForContextsQueries - Queries to be sent with the request
Return Type
- PageBeanIssueTypeToContextMapping|error - Returned if operation is successful
post api/'3/'field/[string fieldId]/context/mapping
Isolated FunctionResource Function
function post api/'3/'field/[string fieldId]/context/mapping(ProjectIssueTypeMappings payload, map<string|string[]> headers, *GetCustomFieldContextsForProjectsAndIssueTypesQueries queries) returns PageBeanContextForProjectAndIssueType|errorGet custom field contexts for projects and issue types
Parameters
- payload ProjectIssueTypeMappings - The list of project and issue type mappings
- queries *GetCustomFieldContextsForProjectsAndIssueTypesQueries - Queries to be sent with the request
Return Type
- PageBeanContextForProjectAndIssueType|error - Returned if the request is successful
get api/'3/'field/[string fieldId]/context/projectmapping
Isolated FunctionResource Function
function get api/'3/'field/[string fieldId]/context/projectmapping(map<string|string[]> headers, *GetProjectContextMappingQueries queries) returns PageBeanCustomFieldContextProjectMapping|errorGet project mappings for custom field context
Parameters
- queries *GetProjectContextMappingQueries - Queries to be sent with the request
Return Type
- PageBeanCustomFieldContextProjectMapping|error - Returned if the request is successful
put api/'3/'field/[string fieldId]/context/[int contextId]
Isolated FunctionResource Function
function put api/'3/'field/[string fieldId]/context/[int contextId](CustomFieldContextUpdateDetails payload, map<string|string[]> headers) returns json|errorUpdate custom field context
Parameters
- payload CustomFieldContextUpdateDetails -
Return Type
- json|error - Returned if the context is updated
delete api/'3/'field/[string fieldId]/context/[int contextId]
Isolated FunctionResource Function
function delete api/'3/'field/[string fieldId]/context/[int contextId](map<string|string[]> headers) returns json|errorDelete custom field context
Return Type
- json|error - Returned if the context is deleted
put api/'3/'field/[string fieldId]/context/[int contextId]/issuetype
Isolated FunctionResource Function
function put api/'3/'field/[string fieldId]/context/[int contextId]/issuetype(IssueTypeIds payload, map<string|string[]> headers) returns json|errorAdd issue types to context
Parameters
- payload IssueTypeIds -
Return Type
- json|error - Returned if operation is successful
post api/'3/'field/[string fieldId]/context/[int contextId]/issuetype/remove
Isolated FunctionResource Function
function post api/'3/'field/[string fieldId]/context/[int contextId]/issuetype/remove(IssueTypeIds payload, map<string|string[]> headers) returns json|errorRemove issue types from context
Parameters
- payload IssueTypeIds -
Return Type
- json|error - Returned if operation is successful
get api/'3/'field/[string fieldId]/context/[int contextId]/option
Isolated FunctionResource Function
function get api/'3/'field/[string fieldId]/context/[int contextId]/option(map<string|string[]> headers, *GetOptionsForContextQueries queries) returns PageBeanCustomFieldContextOption|errorGet custom field options (context)
Parameters
- queries *GetOptionsForContextQueries - Queries to be sent with the request
Return Type
- PageBeanCustomFieldContextOption|error - Returned if the request is successful
put api/'3/'field/[string fieldId]/context/[int contextId]/option
Isolated FunctionResource Function
function put api/'3/'field/[string fieldId]/context/[int contextId]/option(BulkCustomFieldOptionUpdateRequest payload, map<string|string[]> headers) returns CustomFieldUpdatedContextOptionsList|errorUpdate custom field options (context)
Parameters
- payload BulkCustomFieldOptionUpdateRequest -
Return Type
- CustomFieldUpdatedContextOptionsList|error - Returned if the request is successful
post api/'3/'field/[string fieldId]/context/[int contextId]/option
Isolated FunctionResource Function
function post api/'3/'field/[string fieldId]/context/[int contextId]/option(BulkCustomFieldOptionCreateRequest payload, map<string|string[]> headers) returns CustomFieldCreatedContextOptionsList|errorCreate custom field options (context)
Parameters
- payload BulkCustomFieldOptionCreateRequest -
Return Type
- CustomFieldCreatedContextOptionsList|error - Returned if the request is successful
put api/'3/'field/[string fieldId]/context/[int contextId]/option/move
Isolated FunctionResource Function
function put api/'3/'field/[string fieldId]/context/[int contextId]/option/move(OrderOfCustomFieldOptions payload, map<string|string[]> headers) returns json|errorReorder custom field options (context)
Parameters
- payload OrderOfCustomFieldOptions -
Return Type
- json|error - Returned if options are reordered
delete api/'3/'field/[string fieldId]/context/[int contextId]/option/[int optionId]
Isolated FunctionResource Function
function delete api/'3/'field/[string fieldId]/context/[int contextId]/option/[int optionId](map<string|string[]> headers) returns error?Delete custom field options (context)
Return Type
- error? - Returned if the option is deleted
delete api/'3/'field/[string fieldId]/context/[int contextId]/option/[int optionId]/issue
Isolated FunctionResource Function
function delete api/'3/'field/[string fieldId]/context/[int contextId]/option/[int optionId]/issue(map<string|string[]> headers, *ReplaceCustomFieldOptionQueries queries) returns Response|errorReplace custom field options
Parameters
- queries *ReplaceCustomFieldOptionQueries - Queries to be sent with the request
put api/'3/'field/[string fieldId]/context/[int contextId]/project
Isolated FunctionResource Function
function put api/'3/'field/[string fieldId]/context/[int contextId]/project(ProjectIds payload, map<string|string[]> headers) returns json|errorAssign custom field context to projects
Parameters
- payload ProjectIds -
Return Type
- json|error - Returned if operation is successful
post api/'3/'field/[string fieldId]/context/[int contextId]/project/remove
Isolated FunctionResource Function
function post api/'3/'field/[string fieldId]/context/[int contextId]/project/remove(ProjectIds payload, map<string|string[]> headers) returns json|errorRemove custom field context from projects
Parameters
- payload ProjectIds -
Return Type
- json|error - Returned if the custom field context is removed from the projects
get api/'3/'field/[string fieldId]/contexts
DeprecatedIsolated FunctionResource Function
function get api/'3/'field/[string fieldId]/contexts(map<string|string[]> headers, *GetContextsForFieldDeprecatedQueries queries) returns PageBeanContext|errorGet contexts for a field
Parameters
- queries *GetContextsForFieldDeprecatedQueries - Queries to be sent with the request
Return Type
- PageBeanContext|error - Returned if the request is successful
Deprecated
get api/'3/'field/[string fieldId]/screens
Isolated FunctionResource Function
function get api/'3/'field/[string fieldId]/screens(map<string|string[]> headers, *GetScreensForFieldQueries queries) returns PageBeanScreenWithTab|errorGet screens for a field
Parameters
- queries *GetScreensForFieldQueries - Queries to be sent with the request
Return Type
- PageBeanScreenWithTab|error - Returned if the request is successful
get api/'3/'field/[string fieldKey]/option
Isolated FunctionResource Function
function get api/'3/'field/[string fieldKey]/option(map<string|string[]> headers, *GetAllIssueFieldOptionsQueries queries) returns PageBeanIssueFieldOption|errorGet all issue field options
Parameters
- queries *GetAllIssueFieldOptionsQueries - Queries to be sent with the request
Return Type
- PageBeanIssueFieldOption|error - Returned if the request is successful
post api/'3/'field/[string fieldKey]/option
Isolated FunctionResource Function
function post api/'3/'field/[string fieldKey]/option(IssueFieldOptionCreateBean payload, map<string|string[]> headers) returns IssueFieldOption|errorCreate issue field option
Parameters
- payload IssueFieldOptionCreateBean -
Return Type
- IssueFieldOption|error - Returned if the request is successful
get api/'3/'field/[string fieldKey]/option/suggestions/edit
Isolated FunctionResource Function
function get api/'3/'field/[string fieldKey]/option/suggestions/edit(map<string|string[]> headers, *GetSelectableIssueFieldOptionsQueries queries) returns PageBeanIssueFieldOption|errorGet selectable issue field options
Parameters
- queries *GetSelectableIssueFieldOptionsQueries - Queries to be sent with the request
Return Type
- PageBeanIssueFieldOption|error - Returned if the request is successful
get api/'3/'field/[string fieldKey]/option/suggestions/search
Isolated FunctionResource Function
function get api/'3/'field/[string fieldKey]/option/suggestions/search(map<string|string[]> headers, *GetVisibleIssueFieldOptionsQueries queries) returns PageBeanIssueFieldOption|errorGet visible issue field options
Parameters
- queries *GetVisibleIssueFieldOptionsQueries - Queries to be sent with the request
Return Type
- PageBeanIssueFieldOption|error - Returned if the request is successful
get api/'3/'field/[string fieldKey]/option/[int optionId]
Isolated FunctionResource Function
function get api/'3/'field/[string fieldKey]/option/[int optionId](map<string|string[]> headers) returns IssueFieldOption|errorGet issue field option
Return Type
- IssueFieldOption|error - Returned if the requested option is returned
put api/'3/'field/[string fieldKey]/option/[int optionId]
Isolated FunctionResource Function
function put api/'3/'field/[string fieldKey]/option/[int optionId](IssueFieldOption payload, map<string|string[]> headers) returns IssueFieldOption|errorUpdate issue field option
Parameters
- payload IssueFieldOption -
Return Type
- IssueFieldOption|error - Returned if the option is updated or created
delete api/'3/'field/[string fieldKey]/option/[int optionId]
Isolated FunctionResource Function
function delete api/'3/'field/[string fieldKey]/option/[int optionId](map<string|string[]> headers) returns json|errorDelete issue field option
Return Type
- json|error - Returned if the field option is deleted
delete api/'3/'field/[string fieldKey]/option/[int optionId]/issue
Isolated FunctionResource Function
function delete api/'3/'field/[string fieldKey]/option/[int optionId]/issue(map<string|string[]> headers, *ReplaceIssueFieldOptionQueries queries) returns Response|errorReplace issue field option
Parameters
- queries *ReplaceIssueFieldOptionQueries - Queries to be sent with the request
delete api/'3/'field/[string id]
Isolated FunctionResource Function
Delete custom field
post api/'3/'field/[string id]
Isolated FunctionResource Function
post api/'3/'field/[string id]/trash
Isolated FunctionResource Function
Move custom field to trash
Return Type
- json|error - Returned if the request is successful
get api/'3/fieldconfiguration
Isolated FunctionResource Function
function get api/'3/fieldconfiguration(map<string|string[]> headers, *GetAllFieldConfigurationsQueries queries) returns PageBeanFieldConfigurationDetails|errorGet all field configurations
Parameters
- queries *GetAllFieldConfigurationsQueries - Queries to be sent with the request
Return Type
- PageBeanFieldConfigurationDetails|error - Returned if the request is successful
post api/'3/fieldconfiguration
Isolated FunctionResource Function
function post api/'3/fieldconfiguration(FieldConfigurationDetails payload, map<string|string[]> headers) returns FieldConfiguration|errorCreate field configuration
Parameters
- payload FieldConfigurationDetails -
Return Type
- FieldConfiguration|error - Returned if the request is successful
put api/'3/fieldconfiguration/[int id]
Isolated FunctionResource Function
function put api/'3/fieldconfiguration/[int id](FieldConfigurationDetails payload, map<string|string[]> headers) returns json|errorUpdate field configuration
Parameters
- payload FieldConfigurationDetails -
Return Type
- json|error - Returned if the request is successful
delete api/'3/fieldconfiguration/[int id]
Isolated FunctionResource Function
Delete field configuration
Return Type
- json|error - Returned if the request is successful
get api/'3/fieldconfiguration/[int id]/fields
Isolated FunctionResource Function
function get api/'3/fieldconfiguration/[int id]/fields(map<string|string[]> headers, *GetFieldConfigurationItemsQueries queries) returns PageBeanFieldConfigurationItem|errorGet field configuration items
Parameters
- queries *GetFieldConfigurationItemsQueries - Queries to be sent with the request
Return Type
- PageBeanFieldConfigurationItem|error - Returned if the request is successful
put api/'3/fieldconfiguration/[int id]/fields
Isolated FunctionResource Function
function put api/'3/fieldconfiguration/[int id]/fields(FieldConfigurationItemsDetails payload, map<string|string[]> headers) returns json|errorUpdate field configuration items
Parameters
- payload FieldConfigurationItemsDetails -
Return Type
- json|error - Returned if the request is successful
get api/'3/fieldconfigurationscheme
Isolated FunctionResource Function
function get api/'3/fieldconfigurationscheme(map<string|string[]> headers, *GetAllFieldConfigurationSchemesQueries queries) returns PageBeanFieldConfigurationScheme|errorGet all field configuration schemes
Parameters
- queries *GetAllFieldConfigurationSchemesQueries - Queries to be sent with the request
Return Type
- PageBeanFieldConfigurationScheme|error - Returned if the request is successful
post api/'3/fieldconfigurationscheme
Isolated FunctionResource Function
function post api/'3/fieldconfigurationscheme(UpdateFieldConfigurationSchemeDetails payload, map<string|string[]> headers) returns FieldConfigurationScheme|errorCreate field configuration scheme
Parameters
- payload UpdateFieldConfigurationSchemeDetails - The details of the field configuration scheme
Return Type
- FieldConfigurationScheme|error - Returned if the request is successful
get api/'3/fieldconfigurationscheme/mapping
Isolated FunctionResource Function
function get api/'3/fieldconfigurationscheme/mapping(map<string|string[]> headers, *GetFieldConfigurationSchemeMappingsQueries queries) returns PageBeanFieldConfigurationIssueTypeItem|errorGet field configuration issue type items
Parameters
- queries *GetFieldConfigurationSchemeMappingsQueries - Queries to be sent with the request
Return Type
- PageBeanFieldConfigurationIssueTypeItem|error - Returned if the request is successful
get api/'3/fieldconfigurationscheme/project
Isolated FunctionResource Function
function get api/'3/fieldconfigurationscheme/project(map<string|string[]> headers, *GetFieldConfigurationSchemeProjectMappingQueries queries) returns PageBeanFieldConfigurationSchemeProjects|errorGet field configuration schemes for projects
Parameters
- queries *GetFieldConfigurationSchemeProjectMappingQueries - Queries to be sent with the request
Return Type
- PageBeanFieldConfigurationSchemeProjects|error - Returned if the request is successful
put api/'3/fieldconfigurationscheme/project
Isolated FunctionResource Function
function put api/'3/fieldconfigurationscheme/project(FieldConfigurationSchemeProjectAssociation payload, map<string|string[]> headers) returns json|errorAssign field configuration scheme to project
Parameters
Return Type
- json|error - Returned if the request is successful
put api/'3/fieldconfigurationscheme/[int id]
Isolated FunctionResource Function
function put api/'3/fieldconfigurationscheme/[int id](UpdateFieldConfigurationSchemeDetails payload, map<string|string[]> headers) returns json|errorUpdate field configuration scheme
Parameters
- payload UpdateFieldConfigurationSchemeDetails - The details of the field configuration scheme
Return Type
- json|error - Returned if the request is successful
delete api/'3/fieldconfigurationscheme/[int id]
Isolated FunctionResource Function
function delete api/'3/fieldconfigurationscheme/[int id](map<string|string[]> headers) returns json|errorDelete field configuration scheme
Return Type
- json|error - Returned if the request is successful
put api/'3/fieldconfigurationscheme/[int id]/mapping
Isolated FunctionResource Function
function put api/'3/fieldconfigurationscheme/[int id]/mapping(AssociateFieldConfigurationsWithIssueTypesRequest payload, map<string|string[]> headers) returns json|errorAssign issue types to field configurations
Parameters
Return Type
- json|error - Returned if the request is successful
post api/'3/fieldconfigurationscheme/[int id]/mapping/delete
Isolated FunctionResource Function
function post api/'3/fieldconfigurationscheme/[int id]/mapping/delete(IssueTypeIdsToRemove payload, map<string|string[]> headers) returns json|errorRemove issue types from field configuration scheme
Parameters
- payload IssueTypeIdsToRemove - The issue type IDs to remove
Return Type
- json|error - Returned if the request is successful
post api/'3/filter
Isolated FunctionResource Function
function post api/'3/filter(Filter payload, map<string|string[]> headers, *CreateFilterQueries queries) returns Filter|errorCreate filter
Parameters
- payload Filter - The filter to create
- queries *CreateFilterQueries - Queries to be sent with the request
get api/'3/filter/defaultShareScope
Isolated FunctionResource Function
function get api/'3/filter/defaultShareScope(map<string|string[]> headers) returns DefaultShareScope|errorGet default share scope
Return Type
- DefaultShareScope|error - Returned if the request is successful
put api/'3/filter/defaultShareScope
Isolated FunctionResource Function
function put api/'3/filter/defaultShareScope(DefaultShareScope payload, map<string|string[]> headers) returns DefaultShareScope|errorSet default share scope
Parameters
- payload DefaultShareScope -
Return Type
- DefaultShareScope|error - Returned if the request is successful
get api/'3/filter/favourite
Isolated FunctionResource Function
function get api/'3/filter/favourite(map<string|string[]> headers, *GetFavouriteFiltersQueries queries) returns Filter[]|errorGet favorite filters
Parameters
- queries *GetFavouriteFiltersQueries - Queries to be sent with the request
get api/'3/filter/my
Isolated FunctionResource Function
function get api/'3/filter/my(map<string|string[]> headers, *GetMyFiltersQueries queries) returns Filter[]|errorGet my filters
Parameters
- queries *GetMyFiltersQueries - Queries to be sent with the request
get api/'3/filter/search
Isolated FunctionResource Function
function get api/'3/filter/search(map<string|string[]> headers, *GetFiltersPaginatedQueries queries) returns PageBeanFilterDetails|errorSearch for filters
Parameters
- queries *GetFiltersPaginatedQueries - Queries to be sent with the request
Return Type
- PageBeanFilterDetails|error - Returned if the request is successful
get api/'3/filter/[int id]
Isolated FunctionResource Function
function get api/'3/filter/[int id](map<string|string[]> headers, *GetFilterQueries queries) returns Filter|errorGet filter
Parameters
- queries *GetFilterQueries - Queries to be sent with the request
put api/'3/filter/[int id]
Isolated FunctionResource Function
function put api/'3/filter/[int id](Filter payload, map<string|string[]> headers, *UpdateFilterQueries queries) returns Filter|errorUpdate filter
Parameters
- payload Filter - The filter to update
- queries *UpdateFilterQueries - Queries to be sent with the request
delete api/'3/filter/[int id]
Isolated FunctionResource Function
Delete filter
Return Type
- error? - Returned if the request is successful
get api/'3/filter/[int id]/columns
Isolated FunctionResource Function
function get api/'3/filter/[int id]/columns(map<string|string[]> headers) returns ColumnItem[]|errorGet columns
Return Type
- ColumnItem[]|error - Returned if the request is successful
put api/'3/filter/[int id]/columns
Isolated FunctionResource Function
function put api/'3/filter/[int id]/columns(Request request, map<string|string[]> headers) returns json|errorSet columns
Parameters
- request Request - The IDs of the fields to set as columns. In the form data, specify each field as
columns=id, whereidis the id of a field (as seen in the response for Get fields). For example,columns=summary
Return Type
- json|error - Returned if the request is successful
delete api/'3/filter/[int id]/columns
Isolated FunctionResource Function
Reset columns
Return Type
- error? - Returned if the request is successful
put api/'3/filter/[int id]/favourite
Isolated FunctionResource Function
function put api/'3/filter/[int id]/favourite(map<string|string[]> headers, *SetFavouriteForFilterQueries queries) returns Filter|errorAdd filter as favorite
Parameters
- queries *SetFavouriteForFilterQueries - Queries to be sent with the request
delete api/'3/filter/[int id]/favourite
Isolated FunctionResource Function
function delete api/'3/filter/[int id]/favourite(map<string|string[]> headers, *DeleteFavouriteForFilterQueries queries) returns Filter|errorRemove filter as favorite
Parameters
- queries *DeleteFavouriteForFilterQueries - Queries to be sent with the request
put api/'3/filter/[int id]/owner
Isolated FunctionResource Function
function put api/'3/filter/[int id]/owner(ChangeFilterOwner payload, map<string|string[]> headers) returns json|errorChange filter owner
Parameters
- payload ChangeFilterOwner - The account ID of the new owner of the filter
Return Type
- json|error - Returned if the request is successful
get api/'3/filter/[int id]/permission
Isolated FunctionResource Function
function get api/'3/filter/[int id]/permission(map<string|string[]> headers) returns SharePermission[]|errorGet share permissions
Return Type
- SharePermission[]|error - Returned if the request is successful
post api/'3/filter/[int id]/permission
Isolated FunctionResource Function
function post api/'3/filter/[int id]/permission(SharePermissionInputBean payload, map<string|string[]> headers) returns SharePermission[]|errorAdd share permission
Parameters
- payload SharePermissionInputBean -
Return Type
- SharePermission[]|error - Returned if the request is successful
get api/'3/filter/[int id]/permission/[int permissionId]
Isolated FunctionResource Function
function get api/'3/filter/[int id]/permission/[int permissionId](map<string|string[]> headers) returns SharePermission|errorGet share permission
Return Type
- SharePermission|error - Returned if the request is successful
delete api/'3/filter/[int id]/permission/[int permissionId]
Isolated FunctionResource Function
function delete api/'3/filter/[int id]/permission/[int permissionId](map<string|string[]> headers) returns error?Delete share permission
Return Type
- error? - Returned if the request is successful
get api/'3/group
DeprecatedIsolated FunctionResource Function
function get api/'3/group(map<string|string[]> headers, *GetGroupQueries queries) returns Group|errorGet group
Parameters
- queries *GetGroupQueries - Queries to be sent with the request
Deprecated
post api/'3/group
Isolated FunctionResource Function
Create group
Parameters
- payload AddGroupBean - The name of the group
delete api/'3/group
Isolated FunctionResource Function
function delete api/'3/group(map<string|string[]> headers, *RemoveGroupQueries queries) returns error?Remove group
Parameters
- queries *RemoveGroupQueries - Queries to be sent with the request
Return Type
- error? - Returned if the request is successful
get api/'3/group/bulk
Isolated FunctionResource Function
function get api/'3/group/bulk(map<string|string[]> headers, *BulkGetGroupsQueries queries) returns PageBeanGroupDetails|errorBulk get groups
Parameters
- queries *BulkGetGroupsQueries - Queries to be sent with the request
Return Type
- PageBeanGroupDetails|error - Returned if the request is successful
get api/'3/group/member
Isolated FunctionResource Function
function get api/'3/group/member(map<string|string[]> headers, *GetUsersFromGroupQueries queries) returns PageBeanUserDetails|errorGet users from group
Parameters
- queries *GetUsersFromGroupQueries - Queries to be sent with the request
Return Type
- PageBeanUserDetails|error - Returned if the request is successful
post api/'3/group/user
Isolated FunctionResource Function
function post api/'3/group/user(UpdateUserToGroupBean payload, map<string|string[]> headers, *AddUserToGroupQueries queries) returns Group|errorAdd user to group
Parameters
- payload UpdateUserToGroupBean - The user to add to the group
- queries *AddUserToGroupQueries - Queries to be sent with the request
delete api/'3/group/user
Isolated FunctionResource Function
function delete api/'3/group/user(map<string|string[]> headers, *RemoveUserFromGroupQueries queries) returns error?Remove user from group
Parameters
- queries *RemoveUserFromGroupQueries - Queries to be sent with the request
Return Type
- error? - Returned if the request is successful
get api/'3/groups/picker
Isolated FunctionResource Function
function get api/'3/groups/picker(map<string|string[]> headers, *FindGroupsQueries queries) returns FoundGroups|errorFind groups
Parameters
- queries *FindGroupsQueries - Queries to be sent with the request
Return Type
- FoundGroups|error - Returned if the request is successful
get api/'3/groupuserpicker
Isolated FunctionResource Function
function get api/'3/groupuserpicker(map<string|string[]> headers, *FindUsersAndGroupsQueries queries) returns FoundUsersAndGroups|errorFind users and groups
Parameters
- queries *FindUsersAndGroupsQueries - Queries to be sent with the request
Return Type
- FoundUsersAndGroups|error - Returned if the request is successful
get api/'3/instance/license
Isolated FunctionResource Function
Get license
post api/'3/issue
Isolated FunctionResource Function
function post api/'3/issue(IssueUpdateDetails payload, map<string|string[]> headers, *CreateIssueQueries queries) returns CreatedIssue|errorCreate issue
Parameters
- payload IssueUpdateDetails -
- queries *CreateIssueQueries - Queries to be sent with the request
Return Type
- CreatedIssue|error - Returned if the request is successful
put api/'3/issue/archive
Isolated FunctionResource Function
function put api/'3/issue/archive(IssueArchivalSyncRequest payload, map<string|string[]> headers) returns IssueArchivalSyncResponse|errorArchive issue(s) by issue ID/key
Parameters
- payload IssueArchivalSyncRequest - Contains a list of issue keys or IDs to be archived
Return Type
- IssueArchivalSyncResponse|error - Returned if there is at least one valid issue to archive in the request. The return message will include the count of archived issues and subtasks, as well as error details for issues which failed to get archived
post api/'3/issue/archive
Isolated FunctionResource Function
function post api/'3/issue/archive(ArchiveIssueAsyncRequest payload, map<string|string[]> headers) returns string|errorArchive issue(s) by JQL
Parameters
- payload ArchiveIssueAsyncRequest - A JQL query specifying the issues to archive. Note that subtasks can only be archived through their parent issues
post api/'3/issue/bulk
Isolated FunctionResource Function
function post api/'3/issue/bulk(IssuesUpdateBean payload, map<string|string[]> headers) returns CreatedIssues|errorBulk create issue
Parameters
- payload IssuesUpdateBean -
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
post api/'3/issue/bulkfetch
Isolated FunctionResource Function
function post api/'3/issue/bulkfetch(BulkFetchIssueRequestBean payload, map<string|string[]> headers) returns BulkIssueResults|errorBulk fetch issues
Parameters
- payload BulkFetchIssueRequestBean - A JSON object containing the information about which issues and fields to fetch
Return Type
- BulkIssueResults|error - Returned if the request is successful. A response may contain both successful issues and issue errors
get api/'3/issue/createmeta
DeprecatedIsolated FunctionResource Function
function get api/'3/issue/createmeta(map<string|string[]> headers, *GetCreateIssueMetaQueries queries) returns IssueCreateMetadata|errorGet create issue metadata
Parameters
- queries *GetCreateIssueMetaQueries - Queries to be sent with the request
Return Type
- IssueCreateMetadata|error - Returned if the request is successful
Deprecated
get api/'3/issue/createmeta/[string projectIdOrKey]/issuetypes
Isolated FunctionResource Function
function get api/'3/issue/createmeta/[string projectIdOrKey]/issuetypes(map<string|string[]> headers, *GetCreateIssueMetaIssueTypesQueries queries) returns PageOfCreateMetaIssueTypes|errorGet create metadata issue types for a project
Parameters
- queries *GetCreateIssueMetaIssueTypesQueries - Queries to be sent with the request
Return Type
- PageOfCreateMetaIssueTypes|error - Returned if the request is successful
get api/'3/issue/createmeta/[string projectIdOrKey]/issuetypes/[string issueTypeId]
Isolated FunctionResource Function
function get api/'3/issue/createmeta/[string projectIdOrKey]/issuetypes/[string issueTypeId](map<string|string[]> headers, *GetCreateIssueMetaIssueTypeIdQueries queries) returns PageOfCreateMetaIssueTypeWithField|errorGet create field metadata for a project and issue type id
Parameters
- queries *GetCreateIssueMetaIssueTypeIdQueries - Queries to be sent with the request
Return Type
- PageOfCreateMetaIssueTypeWithField|error - Returned if the request is successful
get api/'3/issue/'limit/report
Isolated FunctionResource Function
function get api/'3/issue/'limit/report(map<string|string[]> headers, *GetIssueLimitReportQueries queries) returns IssueLimitReportResponseBean|errorGet issue limit report
Parameters
- queries *GetIssueLimitReportQueries - Queries to be sent with the request
Return Type
- IssueLimitReportResponseBean|error - Returned if the request is successful
get api/'3/issue/picker
Isolated FunctionResource Function
function get api/'3/issue/picker(map<string|string[]> headers, *GetIssuePickerResourceQueries queries) returns IssuePickerSuggestions|errorGet issue picker suggestions
Parameters
- queries *GetIssuePickerResourceQueries - Queries to be sent with the request
Return Type
- IssuePickerSuggestions|error - Returned if the request is successful
post api/'3/issue/properties
Isolated FunctionResource Function
function post api/'3/issue/properties(IssueEntityProperties payload, map<string|string[]> headers) returns error?Bulk set issues properties by list
Parameters
- payload IssueEntityProperties - Issue properties to be set or updated with values
Return Type
- error? - Returned if the operation is successful
post api/'3/issue/properties/multi
Isolated FunctionResource Function
function post api/'3/issue/properties/multi(MultiIssueEntityProperties payload, map<string|string[]> headers) returns error?Bulk set issue properties by issue
Parameters
- payload MultiIssueEntityProperties - Details of the issue properties to be set or updated. Note that if an issue is not found, it is ignored
Return Type
- error? - Returned if the operation is successful
put api/'3/issue/properties/[string propertyKey]
Isolated FunctionResource Function
function put api/'3/issue/properties/[string propertyKey](BulkIssuePropertyUpdateRequest payload, map<string|string[]> headers) returns error?Bulk set issue property
Parameters
- payload BulkIssuePropertyUpdateRequest -
Return Type
- error? - Returned if the request is successful
delete api/'3/issue/properties/[string propertyKey]
Isolated FunctionResource Function
function delete api/'3/issue/properties/[string propertyKey](IssueFilterForBulkPropertyDelete payload, map<string|string[]> headers) returns error?Bulk delete issue property
Parameters
- payload IssueFilterForBulkPropertyDelete -
Return Type
- error? - Returned if the request is successful
put api/'3/issue/unarchive
Isolated FunctionResource Function
function put api/'3/issue/unarchive(IssueArchivalSyncRequest payload, map<string|string[]> headers) returns IssueArchivalSyncResponse|errorUnarchive issue(s) by issue keys/ID
Parameters
- payload IssueArchivalSyncRequest - Contains a list of issue keys or IDs to be unarchived
Return Type
- IssueArchivalSyncResponse|error - Returned if there is at least one valid issue to unarchive in the request. It will return the count of unarchived issues, which also includes the count of the subtasks unarchived, and it will show the detailed errors for those issues which are not unarchived
post api/'3/issue/watching
Isolated FunctionResource Function
function post api/'3/issue/watching(IssueList payload, map<string|string[]> headers) returns BulkIssueIsWatching|errorGet is watching issue bulk
Parameters
- payload IssueList - A list of issue IDs
Return Type
- BulkIssueIsWatching|error - Returned if the request is successful
get api/'3/issue/[string issueIdOrKey]
Isolated FunctionResource Function
function get api/'3/issue/[string issueIdOrKey](map<string|string[]> headers, *GetIssueQueries queries) returns IssueBean|errorGet issue
Parameters
- queries *GetIssueQueries - Queries to be sent with the request
put api/'3/issue/[string issueIdOrKey]
Isolated FunctionResource Function
function put api/'3/issue/[string issueIdOrKey](IssueUpdateDetails payload, map<string|string[]> headers, *EditIssueQueries queries) returns json|errorEdit issue
Parameters
- payload IssueUpdateDetails -
- queries *EditIssueQueries - Queries to be sent with the request
Return Type
- json|error - Returned if the request is successful and the
returnIssueparameter istrue
delete api/'3/issue/[string issueIdOrKey]
Isolated FunctionResource Function
function delete api/'3/issue/[string issueIdOrKey](map<string|string[]> headers, *DeleteIssueQueries queries) returns error?Delete issue
Parameters
- queries *DeleteIssueQueries - Queries to be sent with the request
Return Type
- error? - Returned if the request is successful
put api/'3/issue/[string issueIdOrKey]/assignee
Isolated FunctionResource Function
function put api/'3/issue/[string issueIdOrKey]/assignee(User payload, map<string|string[]> headers) returns json|errorAssign issue
Parameters
- payload User - The request object with the user that the issue is assigned to
Return Type
- json|error - Returned if the request is successful
post api/'3/issue/[string issueIdOrKey]/attachments
Isolated FunctionResource Function
function post api/'3/issue/[string issueIdOrKey]/attachments(MultipartFile[] payload, map<string|string[]> headers) returns Attachment[]|errorAdd attachment
Parameters
- payload MultipartFile[] -
Return Type
- Attachment[]|error - Returned if the request is successful
get api/'3/issue/[string issueIdOrKey]/changelog
Isolated FunctionResource Function
function get api/'3/issue/[string issueIdOrKey]/changelog(map<string|string[]> headers, *GetChangeLogsQueries queries) returns PageBeanChangelog|errorGet changelogs
Parameters
- queries *GetChangeLogsQueries - Queries to be sent with the request
Return Type
- PageBeanChangelog|error - Returned if the request is successful
post api/'3/issue/[string issueIdOrKey]/changelog/list
Isolated FunctionResource Function
function post api/'3/issue/[string issueIdOrKey]/changelog/list(IssueChangelogIds payload, map<string|string[]> headers) returns PageOfChangelogs|errorGet changelogs by IDs
Parameters
- payload IssueChangelogIds -
Return Type
- PageOfChangelogs|error - Returned if the request is successful
get api/'3/issue/[string issueIdOrKey]/comment
Isolated FunctionResource Function
function get api/'3/issue/[string issueIdOrKey]/comment(map<string|string[]> headers, *GetCommentsQueries queries) returns PageOfComments|errorGet comments
Parameters
- queries *GetCommentsQueries - Queries to be sent with the request
Return Type
- PageOfComments|error - Returned if the request is successful
post api/'3/issue/[string issueIdOrKey]/comment
Isolated FunctionResource Function
function post api/'3/issue/[string issueIdOrKey]/comment(Comment payload, map<string|string[]> headers, *AddCommentQueries queries) returns Comment|errorAdd comment
get api/'3/issue/[string issueIdOrKey]/comment/[string id]
Isolated FunctionResource Function
function get api/'3/issue/[string issueIdOrKey]/comment/[string id](map<string|string[]> headers, *GetCommentQueries queries) returns Comment|errorGet comment
Parameters
- queries *GetCommentQueries - Queries to be sent with the request
put api/'3/issue/[string issueIdOrKey]/comment/[string id]
Isolated FunctionResource Function
function put api/'3/issue/[string issueIdOrKey]/comment/[string id](Comment payload, map<string|string[]> headers, *UpdateCommentQueries queries) returns Comment|errorUpdate comment
delete api/'3/issue/[string issueIdOrKey]/comment/[string id]
Isolated FunctionResource Function
function delete api/'3/issue/[string issueIdOrKey]/comment/[string id](map<string|string[]> headers) returns error?Delete comment
Return Type
- error? - Returned if the request is successful
get api/'3/issue/[string issueIdOrKey]/editmeta
Isolated FunctionResource Function
function get api/'3/issue/[string issueIdOrKey]/editmeta(map<string|string[]> headers, *GetEditIssueMetaQueries queries) returns IssueUpdateMetadata|errorGet edit issue metadata
Parameters
- queries *GetEditIssueMetaQueries - Queries to be sent with the request
Return Type
- IssueUpdateMetadata|error - Returned if the request is successful
post api/'3/issue/[string issueIdOrKey]/notify
Isolated FunctionResource Function
function post api/'3/issue/[string issueIdOrKey]/notify(Notification payload, map<string|string[]> headers) returns json|errorSend notification for issue
Parameters
- payload Notification - The request object for the notification and recipients
Return Type
- json|error - Returned if the email is queued for sending
get api/'3/issue/[string issueIdOrKey]/properties
Isolated FunctionResource Function
function get api/'3/issue/[string issueIdOrKey]/properties(map<string|string[]> headers) returns PropertyKeys|errorGet issue property keys
Return Type
- PropertyKeys|error - Returned if the request is successful
get api/'3/issue/[string issueIdOrKey]/properties/[string propertyKey]
Isolated FunctionResource Function
function get api/'3/issue/[string issueIdOrKey]/properties/[string propertyKey](map<string|string[]> headers) returns EntityProperty|errorGet issue property
Return Type
- EntityProperty|error - Returned if the request is successful
put api/'3/issue/[string issueIdOrKey]/properties/[string propertyKey]
Isolated FunctionResource Function
function put api/'3/issue/[string issueIdOrKey]/properties/[string propertyKey](json payload, map<string|string[]> headers) returns json|errorSet issue property
Parameters
- payload json - The value of the property. The value has to be a valid, non-empty JSON value. The maximum length of the property value is 32768 bytes
Return Type
- json|error - Returned if the issue property is updated
delete api/'3/issue/[string issueIdOrKey]/properties/[string propertyKey]
Isolated FunctionResource Function
function delete api/'3/issue/[string issueIdOrKey]/properties/[string propertyKey](map<string|string[]> headers) returns error?Delete issue property
Return Type
- error? - Returned if the request is successful
get api/'3/issue/[string issueIdOrKey]/remotelink
Isolated FunctionResource Function
function get api/'3/issue/[string issueIdOrKey]/remotelink(map<string|string[]> headers, *GetRemoteIssueLinksQueries queries) returns RemoteIssueLink|errorGet remote issue links
Parameters
- queries *GetRemoteIssueLinksQueries - Queries to be sent with the request
Return Type
- RemoteIssueLink|error - Returned if the request is successful
post api/'3/issue/[string issueIdOrKey]/remotelink
Isolated FunctionResource Function
function post api/'3/issue/[string issueIdOrKey]/remotelink(RemoteIssueLinkRequest payload, map<string|string[]> headers) returns RemoteIssueLinkIdentifies|errorCreate or update remote issue link
Parameters
- payload RemoteIssueLinkRequest -
Return Type
- RemoteIssueLinkIdentifies|error - Returned if the remote issue link is updated
delete api/'3/issue/[string issueIdOrKey]/remotelink
Isolated FunctionResource Function
function delete api/'3/issue/[string issueIdOrKey]/remotelink(map<string|string[]> headers, *DeleteRemoteIssueLinkByGlobalIdQueries queries) returns error?Delete remote issue link by global ID
Parameters
- queries *DeleteRemoteIssueLinkByGlobalIdQueries - Queries to be sent with the request
Return Type
- error? - Returned if the request is successful
get api/'3/issue/[string issueIdOrKey]/remotelink/[string linkId]
Isolated FunctionResource Function
function get api/'3/issue/[string issueIdOrKey]/remotelink/[string linkId](map<string|string[]> headers) returns RemoteIssueLink|errorGet remote issue link by ID
Return Type
- RemoteIssueLink|error - Returned if the request is successful
put api/'3/issue/[string issueIdOrKey]/remotelink/[string linkId]
Isolated FunctionResource Function
function put api/'3/issue/[string issueIdOrKey]/remotelink/[string linkId](RemoteIssueLinkRequest payload, map<string|string[]> headers) returns json|errorUpdate remote issue link by ID
Parameters
- payload RemoteIssueLinkRequest -
Return Type
- json|error - Returned if the request is successful
delete api/'3/issue/[string issueIdOrKey]/remotelink/[string linkId]
Isolated FunctionResource Function
function delete api/'3/issue/[string issueIdOrKey]/remotelink/[string linkId](map<string|string[]> headers) returns error?Delete remote issue link by ID
Return Type
- error? - Returned if the request is successful
get api/'3/issue/[string issueIdOrKey]/transitions
Isolated FunctionResource Function
function get api/'3/issue/[string issueIdOrKey]/transitions(map<string|string[]> headers, *GetTransitionsQueries queries) returns Transitions|errorGet transitions
Parameters
- queries *GetTransitionsQueries - Queries to be sent with the request
Return Type
- Transitions|error - Returned if the request is successful
post api/'3/issue/[string issueIdOrKey]/transitions
Isolated FunctionResource Function
function post api/'3/issue/[string issueIdOrKey]/transitions(IssueUpdateDetails payload, map<string|string[]> headers) returns json|errorTransition issue
Parameters
- payload IssueUpdateDetails -
Return Type
- json|error - Returned if the request is successful
get api/'3/issue/[string issueIdOrKey]/votes
Isolated FunctionResource Function
function get api/'3/issue/[string issueIdOrKey]/votes(map<string|string[]> headers) returns Votes|errorGet votes
post api/'3/issue/[string issueIdOrKey]/votes
Isolated FunctionResource Function
function post api/'3/issue/[string issueIdOrKey]/votes(map<string|string[]> headers) returns json|errorAdd vote
Return Type
- json|error - Returned if the request is successful
delete api/'3/issue/[string issueIdOrKey]/votes
Isolated FunctionResource Function
function delete api/'3/issue/[string issueIdOrKey]/votes(map<string|string[]> headers) returns error?Delete vote
Return Type
- error? - Returned if the request is successful
get api/'3/issue/[string issueIdOrKey]/watchers
Isolated FunctionResource Function
function get api/'3/issue/[string issueIdOrKey]/watchers(map<string|string[]> headers) returns Watchers|errorGet issue watchers
post api/'3/issue/[string issueIdOrKey]/watchers
Isolated FunctionResource Function
function post api/'3/issue/[string issueIdOrKey]/watchers(string payload, map<string|string[]> headers) returns json|errorAdd watcher
Parameters
- payload string - The account ID of the user. Note that username cannot be used due to privacy changes
Return Type
- json|error - Returned if the request is successful
delete api/'3/issue/[string issueIdOrKey]/watchers
Isolated FunctionResource Function
function delete api/'3/issue/[string issueIdOrKey]/watchers(map<string|string[]> headers, *RemoveWatcherQueries queries) returns error?Delete watcher
Parameters
- queries *RemoveWatcherQueries - Queries to be sent with the request
Return Type
- error? - Returned if the request is successful
get api/'3/issue/[string issueIdOrKey]/worklog
Isolated FunctionResource Function
function get api/'3/issue/[string issueIdOrKey]/worklog(map<string|string[]> headers, *GetIssueWorklogQueries queries) returns PageOfWorklogs|errorGet issue worklogs
Parameters
- queries *GetIssueWorklogQueries - Queries to be sent with the request
Return Type
- PageOfWorklogs|error - Returned if the request is successful
post api/'3/issue/[string issueIdOrKey]/worklog
Isolated FunctionResource Function
function post api/'3/issue/[string issueIdOrKey]/worklog(Worklog payload, map<string|string[]> headers, *AddWorklogQueries queries) returns Worklog|errorAdd worklog
delete api/'3/issue/[string issueIdOrKey]/worklog
Isolated FunctionResource Function
function delete api/'3/issue/[string issueIdOrKey]/worklog(WorklogIdsRequestBean payload, map<string|string[]> headers, *BulkDeleteWorklogsQueries queries) returns error?Bulk delete worklogs
Parameters
- payload WorklogIdsRequestBean - A JSON object containing a list of worklog IDs
- queries *BulkDeleteWorklogsQueries - Queries to be sent with the request
Return Type
- error? - Returned if the bulk deletion request was partially successful, with a message indicating partial success
post api/'3/issue/[string issueIdOrKey]/worklog/move
Isolated FunctionResource Function
function post api/'3/issue/[string issueIdOrKey]/worklog/move(WorklogsMoveRequestBean payload, map<string|string[]> headers, *BulkMoveWorklogsQueries queries) returns error?Bulk move worklogs
Parameters
- payload WorklogsMoveRequestBean - A JSON object containing a list of worklog IDs and the ID or key of the destination issue
- queries *BulkMoveWorklogsQueries - Queries to be sent with the request
Return Type
- error? - Returned if the request is partially successful
get api/'3/issue/[string issueIdOrKey]/worklog/[string id]
Isolated FunctionResource Function
function get api/'3/issue/[string issueIdOrKey]/worklog/[string id](map<string|string[]> headers, *GetWorklogQueries queries) returns Worklog|errorGet worklog
Parameters
- queries *GetWorklogQueries - Queries to be sent with the request
put api/'3/issue/[string issueIdOrKey]/worklog/[string id]
Isolated FunctionResource Function
function put api/'3/issue/[string issueIdOrKey]/worklog/[string id](Worklog payload, map<string|string[]> headers, *UpdateWorklogQueries queries) returns Worklog|errorUpdate worklog
delete api/'3/issue/[string issueIdOrKey]/worklog/[string id]
Isolated FunctionResource Function
function delete api/'3/issue/[string issueIdOrKey]/worklog/[string id](map<string|string[]> headers, *DeleteWorklogQueries queries) returns error?Delete worklog
Parameters
- queries *DeleteWorklogQueries - Queries to be sent with the request
Return Type
- error? - Returned if the request is successful
get api/'3/issue/[string issueIdOrKey]/worklog/[string worklogId]/properties
Isolated FunctionResource Function
function get api/'3/issue/[string issueIdOrKey]/worklog/[string worklogId]/properties(map<string|string[]> headers) returns PropertyKeys|errorGet worklog property keys
Return Type
- PropertyKeys|error - Returned if the request is successful
get api/'3/issue/[string issueIdOrKey]/worklog/[string worklogId]/properties/[string propertyKey]
Isolated FunctionResource Function
function get api/'3/issue/[string issueIdOrKey]/worklog/[string worklogId]/properties/[string propertyKey](map<string|string[]> headers) returns EntityProperty|errorGet worklog property
Return Type
- EntityProperty|error - Returned if the request is successful
put api/'3/issue/[string issueIdOrKey]/worklog/[string worklogId]/properties/[string propertyKey]
Isolated FunctionResource Function
function put api/'3/issue/[string issueIdOrKey]/worklog/[string worklogId]/properties/[string propertyKey](json payload, map<string|string[]> headers) returns json|errorSet worklog property
Parameters
- payload json - The value of the property. The value has to be a valid, non-empty JSON value. The maximum length of the property value is 32768 bytes
Return Type
- json|error - Returned if the worklog property is updated
delete api/'3/issue/[string issueIdOrKey]/worklog/[string worklogId]/properties/[string propertyKey]
Isolated FunctionResource Function
function delete api/'3/issue/[string issueIdOrKey]/worklog/[string worklogId]/properties/[string propertyKey](map<string|string[]> headers) returns error?Delete worklog property
Return Type
- error? - Returned if the worklog property is removed
post api/'3/issueLink
Isolated FunctionResource Function
function post api/'3/issueLink(LinkIssueRequestJsonBean payload, map<string|string[]> headers) returns json|errorCreate issue link
Parameters
- payload LinkIssueRequestJsonBean - The issue link request
Return Type
- json|error - Returned if the request is successful
get api/'3/issueLink/[string linkId]
Isolated FunctionResource Function
Get issue link
delete api/'3/issueLink/[string linkId]
Isolated FunctionResource Function
Delete issue link
Return Type
- error? - 200 response
get api/'3/issueLinkType
Isolated FunctionResource Function
function get api/'3/issueLinkType(map<string|string[]> headers) returns IssueLinkTypes|errorGet issue link types
Return Type
- IssueLinkTypes|error - Returned if the request is successful
post api/'3/issueLinkType
Isolated FunctionResource Function
function post api/'3/issueLinkType(IssueLinkType payload, map<string|string[]> headers) returns IssueLinkType|errorCreate issue link type
Parameters
- payload IssueLinkType -
Return Type
- IssueLinkType|error - Returned if the request is successful
get api/'3/issueLinkType/[string issueLinkTypeId]
Isolated FunctionResource Function
function get api/'3/issueLinkType/[string issueLinkTypeId](map<string|string[]> headers) returns IssueLinkType|errorGet issue link type
Return Type
- IssueLinkType|error - Returned if the request is successful
put api/'3/issueLinkType/[string issueLinkTypeId]
Isolated FunctionResource Function
function put api/'3/issueLinkType/[string issueLinkTypeId](IssueLinkType payload, map<string|string[]> headers) returns IssueLinkType|errorUpdate issue link type
Parameters
- payload IssueLinkType -
Return Type
- IssueLinkType|error - Returned if the request is successful
delete api/'3/issueLinkType/[string issueLinkTypeId]
Isolated FunctionResource Function
function delete api/'3/issueLinkType/[string issueLinkTypeId](map<string|string[]> headers) returns error?Delete issue link type
Return Type
- error? - Returned if the request is successful
put api/'3/issues/archive/export
Isolated FunctionResource Function
function put api/'3/issues/archive/export(ArchivedIssuesFilterRequest payload, map<string|string[]> headers) returns ExportArchivedIssuesTaskProgressResponse|errorExport archived issue(s)
Parameters
- payload ArchivedIssuesFilterRequest - You can filter the issues in your request by the
projects,archivedBy,archivedDate,issueTypes, andreportersfields. All filters are optional. If you don't provide any filters, you'll get a list of up to one million archived issues
Return Type
- ExportArchivedIssuesTaskProgressResponse|error - Returns the details of your export task. You can use the get task API to view the progress of your request
get api/'3/issuesecurityschemes
Isolated FunctionResource Function
function get api/'3/issuesecurityschemes(map<string|string[]> headers) returns SecuritySchemes|errorGet issue security schemes
Return Type
- SecuritySchemes|error - Returned if the request is successful
post api/'3/issuesecurityschemes
Isolated FunctionResource Function
function post api/'3/issuesecurityschemes(CreateIssueSecuritySchemeDetails payload, map<string|string[]> headers) returns SecuritySchemeId|errorCreate issue security scheme
Parameters
- payload CreateIssueSecuritySchemeDetails -
Return Type
- SecuritySchemeId|error - Returned if the request is successful
get api/'3/issuesecurityschemes/level
Isolated FunctionResource Function
function get api/'3/issuesecurityschemes/level(map<string|string[]> headers, *GetSecurityLevelsQueries queries) returns PageBeanSecurityLevel|errorGet issue security levels
Parameters
- queries *GetSecurityLevelsQueries - Queries to be sent with the request
Return Type
- PageBeanSecurityLevel|error - Returned if the request is successful
put api/'3/issuesecurityschemes/level/default
Isolated FunctionResource Function
function put api/'3/issuesecurityschemes/level/default(SetDefaultLevelsRequest payload, map<string|string[]> headers) returns json|errorSet default issue security levels
Parameters
- payload SetDefaultLevelsRequest -
Return Type
- json|error - Returned if the request is successful
get api/'3/issuesecurityschemes/level/member
Isolated FunctionResource Function
function get api/'3/issuesecurityschemes/level/member(map<string|string[]> headers, *GetSecurityLevelMembersQueries queries) returns PageBeanSecurityLevelMember|errorGet issue security level members
Parameters
- queries *GetSecurityLevelMembersQueries - Queries to be sent with the request
Return Type
- PageBeanSecurityLevelMember|error - Returned if the request is successful
get api/'3/issuesecurityschemes/project
Isolated FunctionResource Function
function get api/'3/issuesecurityschemes/project(map<string|string[]> headers, *SearchProjectsUsingSecuritySchemesQueries queries) returns PageBeanIssueSecuritySchemeToProjectMapping|errorGet projects using issue security schemes
Parameters
- queries *SearchProjectsUsingSecuritySchemesQueries - Queries to be sent with the request
Return Type
- PageBeanIssueSecuritySchemeToProjectMapping|error - Returned if the request is successful
put api/'3/issuesecurityschemes/project
Isolated FunctionResource Function
function put api/'3/issuesecurityschemes/project(AssociateSecuritySchemeWithProjectDetails payload, map<string|string[]> headers) returns Response|errorAssociate security scheme to project
Parameters
get api/'3/issuesecurityschemes/search
Isolated FunctionResource Function
function get api/'3/issuesecurityschemes/search(map<string|string[]> headers, *SearchSecuritySchemesQueries queries) returns PageBeanSecuritySchemeWithProjects|errorSearch issue security schemes
Parameters
- queries *SearchSecuritySchemesQueries - Queries to be sent with the request
Return Type
- PageBeanSecuritySchemeWithProjects|error - Returned if the request is successful
get api/'3/issuesecurityschemes/[int id]
Isolated FunctionResource Function
function get api/'3/issuesecurityschemes/[int id](map<string|string[]> headers) returns SecurityScheme|errorGet issue security scheme
Return Type
- SecurityScheme|error - Returned if the request is successful
put api/'3/issuesecurityschemes/[string id]
Isolated FunctionResource Function
function put api/'3/issuesecurityschemes/[string id](UpdateIssueSecuritySchemeRequestBean payload, map<string|string[]> headers) returns json|errorUpdate issue security scheme
Parameters
- payload UpdateIssueSecuritySchemeRequestBean -
Return Type
- json|error - Returned if the request is successful
get api/'3/issuesecurityschemes/[int issueSecuritySchemeId]/members
Isolated FunctionResource Function
function get api/'3/issuesecurityschemes/[int issueSecuritySchemeId]/members(map<string|string[]> headers, *GetIssueSecurityLevelMembersQueries queries) returns PageBeanIssueSecurityLevelMember|errorGet issue security level members by issue security scheme
Parameters
- queries *GetIssueSecurityLevelMembersQueries - Queries to be sent with the request
Return Type
- PageBeanIssueSecurityLevelMember|error - Returned if the request is successful
delete api/'3/issuesecurityschemes/[string schemeId]
Isolated FunctionResource Function
function delete api/'3/issuesecurityschemes/[string schemeId](map<string|string[]> headers) returns json|errorDelete issue security scheme
Return Type
- json|error - Returned if the request is successful
put api/'3/issuesecurityschemes/[string schemeId]/level
Isolated FunctionResource Function
function put api/'3/issuesecurityschemes/[string schemeId]/level(AddSecuritySchemeLevelsRequestBean payload, map<string|string[]> headers) returns json|errorAdd issue security levels
Parameters
- payload AddSecuritySchemeLevelsRequestBean -
Return Type
- json|error - Returned if the request is successful
put api/'3/issuesecurityschemes/[string schemeId]/level/[string levelId]
Isolated FunctionResource Function
function put api/'3/issuesecurityschemes/[string schemeId]/level/[string levelId](UpdateIssueSecurityLevelDetails payload, map<string|string[]> headers) returns json|errorUpdate issue security level
Parameters
- payload UpdateIssueSecurityLevelDetails -
Return Type
- json|error - Returned if the request is successful
delete api/'3/issuesecurityschemes/[string schemeId]/level/[string levelId]
Isolated FunctionResource Function
function delete api/'3/issuesecurityschemes/[string schemeId]/level/[string levelId](map<string|string[]> headers, *RemoveLevelQueries queries) returns Response|errorRemove issue security level
Parameters
- queries *RemoveLevelQueries - Queries to be sent with the request
put api/'3/issuesecurityschemes/[string schemeId]/level/[string levelId]/member
Isolated FunctionResource Function
function put api/'3/issuesecurityschemes/[string schemeId]/level/[string levelId]/member(SecuritySchemeMembersRequest payload, map<string|string[]> headers) returns json|errorAdd issue security level members
Parameters
- payload SecuritySchemeMembersRequest -
Return Type
- json|error - Returned if the request is successful
delete api/'3/issuesecurityschemes/[string schemeId]/level/[string levelId]/member/[string memberId]
Isolated FunctionResource Function
function delete api/'3/issuesecurityschemes/[string schemeId]/level/[string levelId]/member/[string memberId](map<string|string[]> headers) returns json|errorRemove member from issue security level
Return Type
- json|error - Returned if the request is successful
get api/'3/issuetype
Isolated FunctionResource Function
function get api/'3/issuetype(map<string|string[]> headers) returns IssueTypeDetails[]|errorGet all issue types for user
Return Type
- IssueTypeDetails[]|error - Returned if the request is successful
post api/'3/issuetype
Isolated FunctionResource Function
function post api/'3/issuetype(IssueTypeCreateBean payload, map<string|string[]> headers) returns IssueTypeDetails|errorCreate issue type
Parameters
- payload IssueTypeCreateBean -
Return Type
- IssueTypeDetails|error - Returned if the request is successful
get api/'3/issuetype/project
Isolated FunctionResource Function
function get api/'3/issuetype/project(map<string|string[]> headers, *GetIssueTypesForProjectQueries queries) returns IssueTypeDetails[]|errorGet issue types for project
Parameters
- queries *GetIssueTypesForProjectQueries - Queries to be sent with the request
Return Type
- IssueTypeDetails[]|error - Returned if the request is successful
get api/'3/issuetype/[string id]
Isolated FunctionResource Function
function get api/'3/issuetype/[string id](map<string|string[]> headers) returns IssueTypeDetails|errorGet issue type
Return Type
- IssueTypeDetails|error - Returned if the request is successful
put api/'3/issuetype/[string id]
Isolated FunctionResource Function
function put api/'3/issuetype/[string id](IssueTypeUpdateBean payload, map<string|string[]> headers) returns IssueTypeDetails|errorUpdate issue type
Parameters
- payload IssueTypeUpdateBean -
Return Type
- IssueTypeDetails|error - Returned if the request is successful
delete api/'3/issuetype/[string id]
Isolated FunctionResource Function
function delete api/'3/issuetype/[string id](map<string|string[]> headers, *DeleteIssueTypeQueries queries) returns error?Delete issue type
Parameters
- queries *DeleteIssueTypeQueries - Queries to be sent with the request
Return Type
- error? - Returned if the request is successful
get api/'3/issuetype/[string id]/alternatives
Isolated FunctionResource Function
function get api/'3/issuetype/[string id]/alternatives(map<string|string[]> headers) returns IssueTypeDetails[]|errorGet alternative issue types
Return Type
- IssueTypeDetails[]|error - Returned if the request is successful
post api/'3/issuetype/[string id]/avatar2
Isolated FunctionResource Function
function post api/'3/issuetype/[string id]/avatar2(Request request, map<string|string[]> headers, *CreateIssueTypeAvatarQueries queries) returns Avatar|errorLoad issue type avatar
Parameters
- request Request -
- queries *CreateIssueTypeAvatarQueries - Queries to be sent with the request
get api/'3/issuetype/[string issueTypeId]/properties
Isolated FunctionResource Function
function get api/'3/issuetype/[string issueTypeId]/properties(map<string|string[]> headers) returns PropertyKeys|errorGet issue type property keys
Return Type
- PropertyKeys|error - Returned if the request is successful
get api/'3/issuetype/[string issueTypeId]/properties/[string propertyKey]
Isolated FunctionResource Function
function get api/'3/issuetype/[string issueTypeId]/properties/[string propertyKey](map<string|string[]> headers) returns EntityProperty|errorGet issue type property
Return Type
- EntityProperty|error - Returned if the request is successful
put api/'3/issuetype/[string issueTypeId]/properties/[string propertyKey]
Isolated FunctionResource Function
function put api/'3/issuetype/[string issueTypeId]/properties/[string propertyKey](json payload, map<string|string[]> headers) returns json|errorSet issue type property
Parameters
- payload json - The value of the property. The value has to be a valid, non-empty JSON value. The maximum length of the property value is 32768 bytes
Return Type
- json|error - Returned if the issue type property is updated
delete api/'3/issuetype/[string issueTypeId]/properties/[string propertyKey]
Isolated FunctionResource Function
function delete api/'3/issuetype/[string issueTypeId]/properties/[string propertyKey](map<string|string[]> headers) returns error?Delete issue type property
Return Type
- error? - Returned if the issue type property is deleted
get api/'3/issuetypescheme
Isolated FunctionResource Function
function get api/'3/issuetypescheme(map<string|string[]> headers, *GetAllIssueTypeSchemesQueries queries) returns PageBeanIssueTypeScheme|errorGet all issue type schemes
Parameters
- queries *GetAllIssueTypeSchemesQueries - Queries to be sent with the request
Return Type
- PageBeanIssueTypeScheme|error - Returned if the request is successful
post api/'3/issuetypescheme
Isolated FunctionResource Function
function post api/'3/issuetypescheme(IssueTypeSchemeDetails payload, map<string|string[]> headers) returns IssueTypeSchemeID|errorCreate issue type scheme
Parameters
- payload IssueTypeSchemeDetails -
Return Type
- IssueTypeSchemeID|error - Returned if the request is successful
get api/'3/issuetypescheme/mapping
Isolated FunctionResource Function
function get api/'3/issuetypescheme/mapping(map<string|string[]> headers, *GetIssueTypeSchemesMappingQueries queries) returns PageBeanIssueTypeSchemeMapping|errorGet issue type scheme items
Parameters
- queries *GetIssueTypeSchemesMappingQueries - Queries to be sent with the request
Return Type
- PageBeanIssueTypeSchemeMapping|error - Returned if the request is successful
get api/'3/issuetypescheme/project
Isolated FunctionResource Function
function get api/'3/issuetypescheme/project(map<string|string[]> headers, *GetIssueTypeSchemeForProjectsQueries queries) returns PageBeanIssueTypeSchemeProjects|errorGet issue type schemes for projects
Parameters
- queries *GetIssueTypeSchemeForProjectsQueries - Queries to be sent with the request
Return Type
- PageBeanIssueTypeSchemeProjects|error - Returned if the request is successful
put api/'3/issuetypescheme/project
Isolated FunctionResource Function
function put api/'3/issuetypescheme/project(IssueTypeSchemeProjectAssociation payload, map<string|string[]> headers) returns json|errorAssign issue type scheme to project
Parameters
- payload IssueTypeSchemeProjectAssociation -
Return Type
- json|error - Returned if the request is successful
put api/'3/issuetypescheme/[int issueTypeSchemeId]
Isolated FunctionResource Function
function put api/'3/issuetypescheme/[int issueTypeSchemeId](IssueTypeSchemeUpdateDetails payload, map<string|string[]> headers) returns json|errorUpdate issue type scheme
Parameters
- payload IssueTypeSchemeUpdateDetails -
Return Type
- json|error - Returned if the request is successful
delete api/'3/issuetypescheme/[int issueTypeSchemeId]
Isolated FunctionResource Function
function delete api/'3/issuetypescheme/[int issueTypeSchemeId](map<string|string[]> headers) returns json|errorDelete issue type scheme
Return Type
- json|error - Returned if the issue type scheme is deleted
put api/'3/issuetypescheme/[int issueTypeSchemeId]/issuetype
Isolated FunctionResource Function
function put api/'3/issuetypescheme/[int issueTypeSchemeId]/issuetype(IssueTypeIds payload, map<string|string[]> headers) returns json|errorAdd issue types to issue type scheme
Parameters
- payload IssueTypeIds -
Return Type
- json|error - Returned if the request is successful
put api/'3/issuetypescheme/[int issueTypeSchemeId]/issuetype/move
Isolated FunctionResource Function
function put api/'3/issuetypescheme/[int issueTypeSchemeId]/issuetype/move(OrderOfIssueTypes payload, map<string|string[]> headers) returns json|errorChange order of issue types
Parameters
- payload OrderOfIssueTypes -
Return Type
- json|error - Returned if the request is successful
delete api/'3/issuetypescheme/[int issueTypeSchemeId]/issuetype/[int issueTypeId]
Isolated FunctionResource Function
function delete api/'3/issuetypescheme/[int issueTypeSchemeId]/issuetype/[int issueTypeId](map<string|string[]> headers) returns json|errorRemove issue type from issue type scheme
Return Type
- json|error - Returned if the request is successful
get api/'3/issuetypescreenscheme
Isolated FunctionResource Function
function get api/'3/issuetypescreenscheme(map<string|string[]> headers, *GetIssueTypeScreenSchemesQueries queries) returns PageBeanIssueTypeScreenScheme|errorGet issue type screen schemes
Parameters
- queries *GetIssueTypeScreenSchemesQueries - Queries to be sent with the request
Return Type
- PageBeanIssueTypeScreenScheme|error - Returned if the request is successful
post api/'3/issuetypescreenscheme
Isolated FunctionResource Function
function post api/'3/issuetypescreenscheme(IssueTypeScreenSchemeDetails payload, map<string|string[]> headers) returns IssueTypeScreenSchemeId|errorCreate issue type screen scheme
Parameters
- payload IssueTypeScreenSchemeDetails - An issue type screen scheme bean
Return Type
- IssueTypeScreenSchemeId|error - Returned if the request is successful
get api/'3/issuetypescreenscheme/mapping
Isolated FunctionResource Function
function get api/'3/issuetypescreenscheme/mapping(map<string|string[]> headers, *GetIssueTypeScreenSchemeMappingsQueries queries) returns PageBeanIssueTypeScreenSchemeItem|errorGet issue type screen scheme items
Parameters
- queries *GetIssueTypeScreenSchemeMappingsQueries - Queries to be sent with the request
Return Type
- PageBeanIssueTypeScreenSchemeItem|error - Returned if the request is successful
get api/'3/issuetypescreenscheme/project
Isolated FunctionResource Function
function get api/'3/issuetypescreenscheme/project(map<string|string[]> headers, *GetIssueTypeScreenSchemeProjectAssociationsQueries queries) returns PageBeanIssueTypeScreenSchemesProjects|errorGet issue type screen schemes for projects
Parameters
- queries *GetIssueTypeScreenSchemeProjectAssociationsQueries - Queries to be sent with the request
Return Type
- PageBeanIssueTypeScreenSchemesProjects|error - Returned if the request is successful
put api/'3/issuetypescreenscheme/project
Isolated FunctionResource Function
function put api/'3/issuetypescreenscheme/project(IssueTypeScreenSchemeProjectAssociation payload, map<string|string[]> headers) returns json|errorAssign issue type screen scheme to project
Parameters
- payload IssueTypeScreenSchemeProjectAssociation -
Return Type
- json|error - Returned if the request is successful
put api/'3/issuetypescreenscheme/[string issueTypeScreenSchemeId]
Isolated FunctionResource Function
function put api/'3/issuetypescreenscheme/[string issueTypeScreenSchemeId](IssueTypeScreenSchemeUpdateDetails payload, map<string|string[]> headers) returns json|errorUpdate issue type screen scheme
Parameters
- payload IssueTypeScreenSchemeUpdateDetails - The issue type screen scheme update details
Return Type
- json|error - Returned if the request is successful
delete api/'3/issuetypescreenscheme/[string issueTypeScreenSchemeId]
Isolated FunctionResource Function
function delete api/'3/issuetypescreenscheme/[string issueTypeScreenSchemeId](map<string|string[]> headers) returns json|errorDelete issue type screen scheme
Return Type
- json|error - Returned if the issue type screen scheme is deleted
put api/'3/issuetypescreenscheme/[string issueTypeScreenSchemeId]/mapping
Isolated FunctionResource Function
function put api/'3/issuetypescreenscheme/[string issueTypeScreenSchemeId]/mapping(IssueTypeScreenSchemeMappingDetails payload, map<string|string[]> headers) returns json|errorAppend mappings to issue type screen scheme
Parameters
- payload IssueTypeScreenSchemeMappingDetails -
Return Type
- json|error - Returned if the request is successful
put api/'3/issuetypescreenscheme/[string issueTypeScreenSchemeId]/mapping/default
Isolated FunctionResource Function
function put api/'3/issuetypescreenscheme/[string issueTypeScreenSchemeId]/mapping/default(UpdateDefaultScreenScheme payload, map<string|string[]> headers) returns json|errorUpdate issue type screen scheme default screen scheme
Parameters
- payload UpdateDefaultScreenScheme -
Return Type
- json|error - Returned if the request is successful
post api/'3/issuetypescreenscheme/[string issueTypeScreenSchemeId]/mapping/remove
Isolated FunctionResource Function
function post api/'3/issuetypescreenscheme/[string issueTypeScreenSchemeId]/mapping/remove(IssueTypeIds payload, map<string|string[]> headers) returns json|errorRemove mappings from issue type screen scheme
Parameters
- payload IssueTypeIds -
Return Type
- json|error - Returned if the screen scheme mappings are removed from the issue type screen scheme
get api/'3/issuetypescreenscheme/[int issueTypeScreenSchemeId]/project
Isolated FunctionResource Function
function get api/'3/issuetypescreenscheme/[int issueTypeScreenSchemeId]/project(map<string|string[]> headers, *GetProjectsForIssueTypeScreenSchemeQueries queries) returns PageBeanProjectDetails|errorGet issue type screen scheme projects
Parameters
- queries *GetProjectsForIssueTypeScreenSchemeQueries - Queries to be sent with the request
Return Type
- PageBeanProjectDetails|error - Returned if the request is successful
get api/'3/jql/autocompletedata
Isolated FunctionResource Function
function get api/'3/jql/autocompletedata(map<string|string[]> headers) returns JQLReferenceData|errorGet field reference data (GET)
Return Type
- JQLReferenceData|error - Returned if the request is successful
post api/'3/jql/autocompletedata
Isolated FunctionResource Function
function post api/'3/jql/autocompletedata(SearchAutoCompleteFilter payload, map<string|string[]> headers) returns JQLReferenceData|errorGet field reference data (POST)
Parameters
- payload SearchAutoCompleteFilter -
Return Type
- JQLReferenceData|error - Returned if the request is successful
get api/'3/jql/autocompletedata/suggestions
Isolated FunctionResource Function
function get api/'3/jql/autocompletedata/suggestions(map<string|string[]> headers, *GetFieldAutoCompleteForQueryStringQueries queries) returns AutoCompleteSuggestions|errorGet field auto complete suggestions
Parameters
- queries *GetFieldAutoCompleteForQueryStringQueries - Queries to be sent with the request
Return Type
- AutoCompleteSuggestions|error - Returned if the request is successful
get api/'3/jql/'function/computation
Isolated FunctionResource Function
function get api/'3/jql/'function/computation(map<string|string[]> headers, *GetPrecomputationsQueries queries) returns PageBean2JqlFunctionPrecomputationBean|errorGet precomputations (apps)
Parameters
- queries *GetPrecomputationsQueries - Queries to be sent with the request
Return Type
- PageBean2JqlFunctionPrecomputationBean|error - Returned if the request is successful
post api/'3/jql/'function/computation
Isolated FunctionResource Function
function post api/'3/jql/'function/computation(JqlFunctionPrecomputationUpdateRequestBean payload, map<string|string[]> headers, *UpdatePrecomputationsQueries queries) returns JqlFunctionPrecomputationUpdateResponse|json|errorUpdate precomputations (apps)
Parameters
- queries *UpdatePrecomputationsQueries - Queries to be sent with the request
Return Type
- JqlFunctionPrecomputationUpdateResponse|json|error - 200 response
post api/'3/jql/'function/computation/search
Isolated FunctionResource Function
function post api/'3/jql/'function/computation/search(JqlFunctionPrecomputationGetByIdRequest payload, map<string|string[]> headers, *GetPrecomputationsByIDQueries queries) returns JqlFunctionPrecomputationGetByIdResponse|errorGet precomputations by ID (apps)
Parameters
- payload JqlFunctionPrecomputationGetByIdRequest -
- queries *GetPrecomputationsByIDQueries - Queries to be sent with the request
Return Type
- JqlFunctionPrecomputationGetByIdResponse|error - Returned if the request is successful
post api/'3/jql/'match
Isolated FunctionResource Function
function post api/'3/jql/'match(IssuesAndJQLQueries payload, map<string|string[]> headers) returns IssueMatches|errorCheck issues against JQL
Parameters
- payload IssuesAndJQLQueries -
Return Type
- IssueMatches|error - Returned if the request is successful
post api/'3/jql/parse
Isolated FunctionResource Function
function post api/'3/jql/parse(JqlQueriesToParse payload, map<string|string[]> headers, *ParseJqlQueriesQueries queries) returns ParsedJqlQueries|errorParse JQL query
Parameters
- payload JqlQueriesToParse -
- queries *ParseJqlQueriesQueries - Queries to be sent with the request
Return Type
- ParsedJqlQueries|error - Returned if the request is successful
post api/'3/jql/pdcleaner
Isolated FunctionResource Function
function post api/'3/jql/pdcleaner(JQLPersonalDataMigrationRequest payload, map<string|string[]> headers) returns ConvertedJQLQueries|errorConvert user identifiers to account IDs in JQL queries
Parameters
- payload JQLPersonalDataMigrationRequest -
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
post api/'3/jql/sanitize
Isolated FunctionResource Function
function post api/'3/jql/sanitize(JqlQueriesToSanitize payload, map<string|string[]> headers) returns SanitizedJqlQueries|errorSanitize JQL queries
Parameters
- payload JqlQueriesToSanitize -
Return Type
- SanitizedJqlQueries|error - Returned if the request is successful
get api/'3/label
Isolated FunctionResource Function
function get api/'3/label(map<string|string[]> headers, *GetAllLabelsQueries queries) returns PageBeanString|errorGet all labels
Parameters
- queries *GetAllLabelsQueries - Queries to be sent with the request
Return Type
- PageBeanString|error - Returned if the request is successful
get api/'3/license/approximateLicenseCount
Isolated FunctionResource Function
function get api/'3/license/approximateLicenseCount(map<string|string[]> headers) returns LicenseMetric|errorGet approximate license count
Return Type
- LicenseMetric|error - Returned if the request is successful
get api/'3/license/approximateLicenseCount/product/["jira-core"|"jira-product-discovery"|"jira-software"|"jira-servicedesk" applicationKey]
Isolated FunctionResource Function
function get api/'3/license/approximateLicenseCount/product/["jira-core"|"jira-product-discovery"|"jira-software"|"jira-servicedesk" applicationKey](map<string|string[]> headers) returns LicenseMetric|errorGet approximate application license count
Return Type
- LicenseMetric|error - Returned if the request is successful
get api/'3/mypermissions
Isolated FunctionResource Function
function get api/'3/mypermissions(map<string|string[]> headers, *GetMyPermissionsQueries queries) returns Permissions|errorGet my permissions
Parameters
- queries *GetMyPermissionsQueries - Queries to be sent with the request
Return Type
- Permissions|error - Returned if the request is successful
get api/'3/mypreferences
Isolated FunctionResource Function
function get api/'3/mypreferences(map<string|string[]> headers, *GetPreferenceQueries queries) returns string|errorGet preference
Parameters
- queries *GetPreferenceQueries - Queries to be sent with the request
put api/'3/mypreferences
Isolated FunctionResource Function
function put api/'3/mypreferences(string payload, map<string|string[]> headers, *SetPreferenceQueries queries) returns json|errorSet preference
Parameters
- payload string - The value of the preference as a plain text string. The maximum length is 255 characters
- queries *SetPreferenceQueries - Queries to be sent with the request
Return Type
- json|error - Returned if the request is successful
delete api/'3/mypreferences
Isolated FunctionResource Function
function delete api/'3/mypreferences(map<string|string[]> headers, *RemovePreferenceQueries queries) returns error?Delete preference
Parameters
- queries *RemovePreferenceQueries - Queries to be sent with the request
Return Type
- error? - Returned if the request is successful
get api/'3/mypreferences/locale
Isolated FunctionResource Function
Get locale
put api/'3/mypreferences/locale
DeprecatedIsolated FunctionResource Function
function put api/'3/mypreferences/locale(Locale payload, map<string|string[]> headers) returns json|errorSet locale
Parameters
- payload Locale - The locale defined in a LocaleBean
Return Type
- json|error - Returned if the request is successful
Deprecated
get api/'3/myself
Isolated FunctionResource Function
function get api/'3/myself(map<string|string[]> headers, *GetCurrentUserQueries queries) returns User|errorGet current user
Parameters
- queries *GetCurrentUserQueries - Queries to be sent with the request
get api/'3/notificationscheme
Isolated FunctionResource Function
function get api/'3/notificationscheme(map<string|string[]> headers, *GetNotificationSchemesQueries queries) returns PageBeanNotificationScheme|errorGet notification schemes paginated
Parameters
- queries *GetNotificationSchemesQueries - Queries to be sent with the request
Return Type
- PageBeanNotificationScheme|error - Returned if the request is successful. Only returns notification schemes that the user has permission to access. An empty list is returned if the user lacks permission to access all notification schemes
post api/'3/notificationscheme
Isolated FunctionResource Function
function post api/'3/notificationscheme(CreateNotificationSchemeDetails payload, map<string|string[]> headers) returns NotificationSchemeId|errorCreate notification scheme
Parameters
- payload CreateNotificationSchemeDetails -
Return Type
- NotificationSchemeId|error - Returned if the request is successful
get api/'3/notificationscheme/project
Isolated FunctionResource Function
function get api/'3/notificationscheme/project(map<string|string[]> headers, *GetNotificationSchemeToProjectMappingsQueries queries) returns PageBeanNotificationSchemeAndProjectMappingJsonBean|errorGet projects using notification schemes paginated
Parameters
- queries *GetNotificationSchemeToProjectMappingsQueries - Queries to be sent with the request
Return Type
- PageBeanNotificationSchemeAndProjectMappingJsonBean|error - Returned if the request is successful
get api/'3/notificationscheme/[int id]
Isolated FunctionResource Function
function get api/'3/notificationscheme/[int id](map<string|string[]> headers, *GetNotificationSchemeQueries queries) returns NotificationScheme|errorGet notification scheme
Parameters
- queries *GetNotificationSchemeQueries - Queries to be sent with the request
Return Type
- NotificationScheme|error - Returned if the request is successful
put api/'3/notificationscheme/[string id]
Isolated FunctionResource Function
function put api/'3/notificationscheme/[string id](UpdateNotificationSchemeDetails payload, map<string|string[]> headers) returns json|errorUpdate notification scheme
Parameters
- payload UpdateNotificationSchemeDetails -
Return Type
- json|error - Returned if the request is successful
put api/'3/notificationscheme/[string id]/notification
Isolated FunctionResource Function
function put api/'3/notificationscheme/[string id]/notification(AddNotificationsDetails payload, map<string|string[]> headers) returns json|errorAdd notifications to notification scheme
Parameters
- payload AddNotificationsDetails -
Return Type
- json|error - Returned if the request is successful
delete api/'3/notificationscheme/[string notificationSchemeId]
Isolated FunctionResource Function
function delete api/'3/notificationscheme/[string notificationSchemeId](map<string|string[]> headers) returns json|errorDelete notification scheme
Return Type
- json|error - Returned if the request is successful
delete api/'3/notificationscheme/[string notificationSchemeId]/notification/[string notificationId]
Isolated FunctionResource Function
function delete api/'3/notificationscheme/[string notificationSchemeId]/notification/[string notificationId](map<string|string[]> headers) returns json|errorRemove notification from notification scheme
Return Type
- json|error - Returned if the request is successful
get api/'3/permissions
Isolated FunctionResource Function
function get api/'3/permissions(map<string|string[]> headers) returns Permissions|errorGet all permissions
Return Type
- Permissions|error - Returned if the request is successful
post api/'3/permissions/'check
Isolated FunctionResource Function
function post api/'3/permissions/'check(BulkPermissionsRequestBean payload, map<string|string[]> headers) returns BulkPermissionGrants|errorGet bulk permissions
Parameters
- payload BulkPermissionsRequestBean - Details of the permissions to check
Return Type
- BulkPermissionGrants|error - Returned if the request is successful
post api/'3/permissions/project
Isolated FunctionResource Function
function post api/'3/permissions/project(PermissionsKeysBean payload, map<string|string[]> headers) returns PermittedProjects|errorGet permitted projects
Parameters
- payload PermissionsKeysBean -
Return Type
- PermittedProjects|error - Returned if the request is successful
get api/'3/permissionscheme
Isolated FunctionResource Function
function get api/'3/permissionscheme(map<string|string[]> headers, *GetAllPermissionSchemesQueries queries) returns PermissionSchemes|errorGet all permission schemes
Parameters
- queries *GetAllPermissionSchemesQueries - Queries to be sent with the request
Return Type
- PermissionSchemes|error - Returned if the request is successful
post api/'3/permissionscheme
Isolated FunctionResource Function
function post api/'3/permissionscheme(PermissionScheme payload, map<string|string[]> headers, *CreatePermissionSchemeQueries queries) returns PermissionScheme|errorCreate permission scheme
Parameters
- payload PermissionScheme - The permission scheme to create
- queries *CreatePermissionSchemeQueries - Queries to be sent with the request
Return Type
- PermissionScheme|error - Returned if the permission scheme is created
get api/'3/permissionscheme/[int schemeId]
Isolated FunctionResource Function
function get api/'3/permissionscheme/[int schemeId](map<string|string[]> headers, *GetPermissionSchemeQueries queries) returns PermissionScheme|errorGet permission scheme
Parameters
- queries *GetPermissionSchemeQueries - Queries to be sent with the request
Return Type
- PermissionScheme|error - Returned if the request is successful
put api/'3/permissionscheme/[int schemeId]
Isolated FunctionResource Function
function put api/'3/permissionscheme/[int schemeId](PermissionScheme payload, map<string|string[]> headers, *UpdatePermissionSchemeQueries queries) returns PermissionScheme|errorUpdate permission scheme
Parameters
- payload PermissionScheme -
- queries *UpdatePermissionSchemeQueries - Queries to be sent with the request
Return Type
- PermissionScheme|error - Returned if the scheme is updated
delete api/'3/permissionscheme/[int schemeId]
Isolated FunctionResource Function
Delete permission scheme
Return Type
- error? - Returned if the permission scheme is deleted
get api/'3/permissionscheme/[int schemeId]/permission
Isolated FunctionResource Function
function get api/'3/permissionscheme/[int schemeId]/permission(map<string|string[]> headers, *GetPermissionSchemeGrantsQueries queries) returns PermissionGrants|errorGet permission scheme grants
Parameters
- queries *GetPermissionSchemeGrantsQueries - Queries to be sent with the request
Return Type
- PermissionGrants|error - Returned if the request is successful
post api/'3/permissionscheme/[int schemeId]/permission
Isolated FunctionResource Function
function post api/'3/permissionscheme/[int schemeId]/permission(PermissionGrant payload, map<string|string[]> headers, *CreatePermissionGrantQueries queries) returns PermissionGrant|errorCreate permission grant
Parameters
- payload PermissionGrant - The permission grant to create
- queries *CreatePermissionGrantQueries - Queries to be sent with the request
Return Type
- PermissionGrant|error - Returned if the scheme permission is created
get api/'3/permissionscheme/[int schemeId]/permission/[int permissionId]
Isolated FunctionResource Function
function get api/'3/permissionscheme/[int schemeId]/permission/[int permissionId](map<string|string[]> headers, *GetPermissionSchemeGrantQueries queries) returns PermissionGrant|errorGet permission scheme grant
Parameters
- queries *GetPermissionSchemeGrantQueries - Queries to be sent with the request
Return Type
- PermissionGrant|error - Returned if the request is successful
delete api/'3/permissionscheme/[int schemeId]/permission/[int permissionId]
Isolated FunctionResource Function
function delete api/'3/permissionscheme/[int schemeId]/permission/[int permissionId](map<string|string[]> headers) returns error?Delete permission scheme grant
Return Type
- error? - Returned if the permission grant is deleted
get api/'3/plans/plan
Isolated FunctionResource Function
function get api/'3/plans/plan(map<string|string[]> headers, *GetPlansQueries queries) returns PageWithCursorGetPlanResponseForPage|errorGet plans paginated
Parameters
- queries *GetPlansQueries - Queries to be sent with the request
Return Type
- PageWithCursorGetPlanResponseForPage|error - Returned if the request is successful
post api/'3/plans/plan
Isolated FunctionResource Function
function post api/'3/plans/plan(CreatePlanRequest payload, map<string|string[]> headers, *CreatePlanQueries queries) returns int|errorCreate plan
Parameters
- payload CreatePlanRequest -
- queries *CreatePlanQueries - Queries to be sent with the request
get api/'3/plans/plan/[int planId]
Isolated FunctionResource Function
function get api/'3/plans/plan/[int planId](map<string|string[]> headers, *GetPlanQueries queries) returns GetPlanResponse|errorGet plan
Parameters
- queries *GetPlanQueries - Queries to be sent with the request
Return Type
- GetPlanResponse|error - Returned if the request is successful
put api/'3/plans/plan/[int planId]
Isolated FunctionResource Function
function put api/'3/plans/plan/[int planId](record {} payload, map<string|string[]> headers, *UpdatePlanQueries queries) returns json|errorUpdate plan
Return Type
- json|error - Returned if the request is successful
put api/'3/plans/plan/[int planId]/archive
Isolated FunctionResource Function
function put api/'3/plans/plan/[int planId]/archive(map<string|string[]> headers) returns json|errorArchive plan
Return Type
- json|error - Returned if the request is successful
post api/'3/plans/plan/[int planId]/duplicate
Isolated FunctionResource Function
function post api/'3/plans/plan/[int planId]/duplicate(DuplicatePlanRequest payload, map<string|string[]> headers) returns int|errorDuplicate plan
Parameters
- payload DuplicatePlanRequest -
get api/'3/plans/plan/[int planId]/team
Isolated FunctionResource Function
function get api/'3/plans/plan/[int planId]/team(map<string|string[]> headers, *GetTeamsQueries queries) returns PageWithCursorGetTeamResponseForPage|errorGet teams in plan paginated
Parameters
- queries *GetTeamsQueries - Queries to be sent with the request
Return Type
- PageWithCursorGetTeamResponseForPage|error - Returned if the request is successful
post api/'3/plans/plan/[int planId]/team/atlassian
Isolated FunctionResource Function
function post api/'3/plans/plan/[int planId]/team/atlassian(AddAtlassianTeamRequest payload, map<string|string[]> headers) returns json|errorAdd Atlassian team to plan
Parameters
- payload AddAtlassianTeamRequest -
Return Type
- json|error - Returned if the request is successful
get api/'3/plans/plan/[int planId]/team/atlassian/[string atlassianTeamId]
Isolated FunctionResource Function
function get api/'3/plans/plan/[int planId]/team/atlassian/[string atlassianTeamId](map<string|string[]> headers) returns GetAtlassianTeamResponse|errorGet Atlassian team in plan
Return Type
- GetAtlassianTeamResponse|error - Returned if the request is successful
put api/'3/plans/plan/[int planId]/team/atlassian/[string atlassianTeamId]
Isolated FunctionResource Function
function put api/'3/plans/plan/[int planId]/team/atlassian/[string atlassianTeamId](record {} payload, map<string|string[]> headers) returns json|errorUpdate Atlassian team in plan
Parameters
- payload record {} -
Return Type
- json|error - Returned if the request is successful
delete api/'3/plans/plan/[int planId]/team/atlassian/[string atlassianTeamId]
Isolated FunctionResource Function
function delete api/'3/plans/plan/[int planId]/team/atlassian/[string atlassianTeamId](map<string|string[]> headers) returns json|errorRemove Atlassian team from plan
Return Type
- json|error - Returned if the request is successful
post api/'3/plans/plan/[int planId]/team/planonly
Isolated FunctionResource Function
function post api/'3/plans/plan/[int planId]/team/planonly(CreatePlanOnlyTeamRequest payload, map<string|string[]> headers) returns int|errorCreate plan-only team
Parameters
- payload CreatePlanOnlyTeamRequest -
get api/'3/plans/plan/[int planId]/team/planonly/[int planOnlyTeamId]
Isolated FunctionResource Function
function get api/'3/plans/plan/[int planId]/team/planonly/[int planOnlyTeamId](map<string|string[]> headers) returns GetPlanOnlyTeamResponse|errorGet plan-only team
Return Type
- GetPlanOnlyTeamResponse|error - Returned if the request is successful
put api/'3/plans/plan/[int planId]/team/planonly/[int planOnlyTeamId]
Isolated FunctionResource Function
function put api/'3/plans/plan/[int planId]/team/planonly/[int planOnlyTeamId](record {} payload, map<string|string[]> headers) returns json|errorUpdate plan-only team
Parameters
- payload record {} -
Return Type
- json|error - Returned if the request is successful
delete api/'3/plans/plan/[int planId]/team/planonly/[int planOnlyTeamId]
Isolated FunctionResource Function
function delete api/'3/plans/plan/[int planId]/team/planonly/[int planOnlyTeamId](map<string|string[]> headers) returns json|errorDelete plan-only team
Return Type
- json|error - Returned if the request is successful
put api/'3/plans/plan/[int planId]/trash
Isolated FunctionResource Function
Trash plan
Return Type
- json|error - Returned if the request is successful
get api/'3/priority
DeprecatedIsolated FunctionResource Function
Get priorities
Deprecated
post api/'3/priority
DeprecatedIsolated FunctionResource Function
function post api/'3/priority(CreatePriorityDetails payload, map<string|string[]> headers) returns PriorityId|errorCreate priority
Parameters
- payload CreatePriorityDetails -
Return Type
- PriorityId|error - Returned if the request is successful
Deprecated
put api/'3/priority/default
Isolated FunctionResource Function
function put api/'3/priority/default(SetDefaultPriorityRequest payload, map<string|string[]> headers) returns json|errorSet default priority
Parameters
- payload SetDefaultPriorityRequest -
Return Type
- json|error - Returned if the request is successful
put api/'3/priority/move
Isolated FunctionResource Function
function put api/'3/priority/move(ReorderIssuePriorities payload, map<string|string[]> headers) returns json|errorMove priorities
Parameters
- payload ReorderIssuePriorities -
Return Type
- json|error - Returned if the request is successful
get api/'3/priority/search
DeprecatedIsolated FunctionResource Function
function get api/'3/priority/search(map<string|string[]> headers, *SearchPrioritiesQueries queries) returns PageBeanPriority|errorSearch priorities
Parameters
- queries *SearchPrioritiesQueries - Queries to be sent with the request
Return Type
- PageBeanPriority|error - Returned if the request is successful
Deprecated
get api/'3/priority/[string id]
Isolated FunctionResource Function
Get priority
put api/'3/priority/[string id]
DeprecatedIsolated FunctionResource Function
function put api/'3/priority/[string id](UpdatePriorityDetails payload, map<string|string[]> headers) returns json|errorUpdate priority
Parameters
- payload UpdatePriorityDetails -
Return Type
- json|error - Returned if the request is successful
Deprecated
delete api/'3/priority/[string id]
Isolated FunctionResource Function
Delete priority
get api/'3/priorityscheme
Isolated FunctionResource Function
function get api/'3/priorityscheme(map<string|string[]> headers, *GetPrioritySchemesQueries queries) returns PageBeanPrioritySchemeWithPaginatedPrioritiesAndProjects|errorGet priority schemes
Parameters
- queries *GetPrioritySchemesQueries - Queries to be sent with the request
Return Type
- PageBeanPrioritySchemeWithPaginatedPrioritiesAndProjects|error - Returned if the request is successful
post api/'3/priorityscheme
Isolated FunctionResource Function
function post api/'3/priorityscheme(CreatePrioritySchemeDetails payload, map<string|string[]> headers) returns PrioritySchemeId|errorCreate priority scheme
Parameters
- payload CreatePrioritySchemeDetails -
Return Type
- PrioritySchemeId|error - Returned if the request is completed
post api/'3/priorityscheme/mappings
Isolated FunctionResource Function
function post api/'3/priorityscheme/mappings(SuggestedMappingsRequestBean payload, map<string|string[]> headers) returns PageBeanPriorityWithSequence|errorSuggested priorities for mappings
Parameters
- payload SuggestedMappingsRequestBean -
Return Type
- PageBeanPriorityWithSequence|error - Returned if the request is successful
get api/'3/priorityscheme/priorities/available
Isolated FunctionResource Function
function get api/'3/priorityscheme/priorities/available(map<string|string[]> headers, *GetAvailablePrioritiesByPrioritySchemeQueries queries) returns PageBeanPriorityWithSequence|errorGet available priorities by priority scheme
Parameters
- queries *GetAvailablePrioritiesByPrioritySchemeQueries - Queries to be sent with the request
Return Type
- PageBeanPriorityWithSequence|error - Returned if the request is successful
put api/'3/priorityscheme/[int schemeId]
Isolated FunctionResource Function
function put api/'3/priorityscheme/[int schemeId](UpdatePrioritySchemeRequestBean payload, map<string|string[]> headers) returns UpdatePrioritySchemeResponseBean|errorUpdate priority scheme
Parameters
- payload UpdatePrioritySchemeRequestBean -
Return Type
- UpdatePrioritySchemeResponseBean|error - Returned if the request is accepted
delete api/'3/priorityscheme/[int schemeId]
Isolated FunctionResource Function
function delete api/'3/priorityscheme/[int schemeId](map<string|string[]> headers) returns json|errorDelete priority scheme
Return Type
- json|error - Returned if the request is successful
get api/'3/priorityscheme/[string schemeId]/priorities
Isolated FunctionResource Function
function get api/'3/priorityscheme/[string schemeId]/priorities(map<string|string[]> headers, *GetPrioritiesByPrioritySchemeQueries queries) returns PageBeanPriorityWithSequence|errorGet priorities by priority scheme
Parameters
- queries *GetPrioritiesByPrioritySchemeQueries - Queries to be sent with the request
Return Type
- PageBeanPriorityWithSequence|error - Returned if the request is successful
get api/'3/priorityscheme/[string schemeId]/projects
Isolated FunctionResource Function
function get api/'3/priorityscheme/[string schemeId]/projects(map<string|string[]> headers, *GetProjectsByPrioritySchemeQueries queries) returns PageBeanProject|errorGet projects by priority scheme
Parameters
- queries *GetProjectsByPrioritySchemeQueries - Queries to be sent with the request
Return Type
- PageBeanProject|error - Returned if the request is successful
get api/'3/project
DeprecatedIsolated FunctionResource Function
function get api/'3/project(map<string|string[]> headers, *GetAllProjectsQueries queries) returns Project[]|errorGet all projects
Parameters
- queries *GetAllProjectsQueries - Queries to be sent with the request
Deprecated
post api/'3/project
Isolated FunctionResource Function
function post api/'3/project(CreateProjectDetails payload, map<string|string[]> headers) returns ProjectIdentifiers|errorCreate project
Parameters
- payload CreateProjectDetails - The JSON representation of the project being created
Return Type
- ProjectIdentifiers|error - Returned if the project is created
post api/'3/project-template
Isolated FunctionResource Function
function post api/'3/project\-template(ProjectCustomTemplateCreateRequestDTO payload, map<string|string[]> headers) returns Response|errorCreate custom project
Parameters
- payload ProjectCustomTemplateCreateRequestDTO - The JSON payload containing the project details and capabilities
get api/'3/project/recent
Isolated FunctionResource Function
function get api/'3/project/recent(map<string|string[]> headers, *GetRecentQueries queries) returns Project[]|errorGet recent projects
Parameters
- queries *GetRecentQueries - Queries to be sent with the request
get api/'3/project/search
Isolated FunctionResource Function
function get api/'3/project/search(map<string|string[]> headers, *SearchProjectsQueries queries) returns PageBeanProject|errorGet projects paginated
Parameters
- queries *SearchProjectsQueries - Queries to be sent with the request
Return Type
- PageBeanProject|error - Returned if the request is successful
get api/'3/project/'type
Isolated FunctionResource Function
function get api/'3/project/'type(map<string|string[]> headers) returns ProjectType[]|errorGet all project types
Return Type
- ProjectType[]|error - Returned if the request is successful
get api/'3/project/'type/accessible
Isolated FunctionResource Function
function get api/'3/project/'type/accessible(map<string|string[]> headers) returns ProjectType[]|errorGet licensed project types
Return Type
- ProjectType[]|error - Returned if the request is successful
get api/'3/project/'type/["software"|"service_desk"|"business"|"product_discovery" projectTypeKey]
Isolated FunctionResource Function
function get api/'3/project/'type/["software"|"service_desk"|"business"|"product_discovery" projectTypeKey](map<string|string[]> headers) returns ProjectType|errorGet project type by key
Return Type
- ProjectType|error - Returned if the request is successful
get api/'3/project/'type/["software"|"service_desk"|"business"|"product_discovery" projectTypeKey]/accessible
Isolated FunctionResource Function
function get api/'3/project/'type/["software"|"service_desk"|"business"|"product_discovery" projectTypeKey]/accessible(map<string|string[]> headers) returns ProjectType|errorGet accessible project type by key
Return Type
- ProjectType|error - Returned if the request is successful
get api/'3/project/[string projectIdOrKey]
Isolated FunctionResource Function
function get api/'3/project/[string projectIdOrKey](map<string|string[]> headers, *GetProjectQueries queries) returns Project|errorGet project
Parameters
- queries *GetProjectQueries - Queries to be sent with the request
put api/'3/project/[string projectIdOrKey]
Isolated FunctionResource Function
function put api/'3/project/[string projectIdOrKey](UpdateProjectDetails payload, map<string|string[]> headers, *UpdateProjectQueries queries) returns Project|errorUpdate project
Parameters
- payload UpdateProjectDetails - The project details to be updated
- queries *UpdateProjectQueries - Queries to be sent with the request
delete api/'3/project/[string projectIdOrKey]
Isolated FunctionResource Function
function delete api/'3/project/[string projectIdOrKey](map<string|string[]> headers, *DeleteProjectQueries queries) returns error?Delete project
Parameters
- queries *DeleteProjectQueries - Queries to be sent with the request
Return Type
- error? - Returned if the project is deleted
post api/'3/project/[string projectIdOrKey]/archive
Isolated FunctionResource Function
function post api/'3/project/[string projectIdOrKey]/archive(map<string|string[]> headers) returns json|errorArchive project
Return Type
- json|error - Returned if the request is successful
put api/'3/project/[string projectIdOrKey]/avatar
Isolated FunctionResource Function
function put api/'3/project/[string projectIdOrKey]/avatar(Avatar payload, map<string|string[]> headers) returns json|errorSet project avatar
Parameters
- payload Avatar -
Return Type
- json|error - Returned if the request is successful
delete api/'3/project/[string projectIdOrKey]/avatar/[int id]
Isolated FunctionResource Function
function delete api/'3/project/[string projectIdOrKey]/avatar/[int id](map<string|string[]> headers) returns error?Delete project avatar
Return Type
- error? - Returned if the request is successful
post api/'3/project/[string projectIdOrKey]/avatar2
Isolated FunctionResource Function
function post api/'3/project/[string projectIdOrKey]/avatar2(Request request, map<string|string[]> headers, *CreateProjectAvatarQueries queries) returns Avatar|errorLoad project avatar
Parameters
- request Request -
- queries *CreateProjectAvatarQueries - Queries to be sent with the request
get api/'3/project/[string projectIdOrKey]/avatars
Isolated FunctionResource Function
function get api/'3/project/[string projectIdOrKey]/avatars(map<string|string[]> headers) returns ProjectAvatars|errorGet all project avatars
Return Type
- ProjectAvatars|error - Returned if request is successful
get api/'3/project/[string projectIdOrKey]/classification-level/default
Isolated FunctionResource Function
function get api/'3/project/[string projectIdOrKey]/classification\-level/default(map<string|string[]> headers) returns json|errorGet the default data classification level of a project
Return Type
- json|error - Returned if the request is successful
put api/'3/project/[string projectIdOrKey]/classification-level/default
Isolated FunctionResource Function
function put api/'3/project/[string projectIdOrKey]/classification\-level/default(UpdateDefaultProjectClassificationBean payload, map<string|string[]> headers) returns json|errorUpdate the default data classification level of a project
Parameters
- payload UpdateDefaultProjectClassificationBean -
Return Type
- json|error - Returned if the request is successful
delete api/'3/project/[string projectIdOrKey]/classification-level/default
Isolated FunctionResource Function
function delete api/'3/project/[string projectIdOrKey]/classification\-level/default(map<string|string[]> headers) returns json|errorRemove the default data classification level from a project
Return Type
- json|error - Returned if the request is successful
get api/'3/project/[string projectIdOrKey]/component
Isolated FunctionResource Function
function get api/'3/project/[string projectIdOrKey]/component(map<string|string[]> headers, *GetProjectComponentsPaginatedQueries queries) returns PageBeanComponentWithIssueCount|errorGet project components paginated
Parameters
- queries *GetProjectComponentsPaginatedQueries - Queries to be sent with the request
Return Type
- PageBeanComponentWithIssueCount|error - Returned if the request is successful
get api/'3/project/[string projectIdOrKey]/components
Isolated FunctionResource Function
function get api/'3/project/[string projectIdOrKey]/components(map<string|string[]> headers, *GetProjectComponentsQueries queries) returns ProjectComponent[]|errorGet project components
Parameters
- queries *GetProjectComponentsQueries - Queries to be sent with the request
Return Type
- ProjectComponent[]|error - Returned if the request is successful
post api/'3/project/[string projectIdOrKey]/delete
Isolated FunctionResource Function
function post api/'3/project/[string projectIdOrKey]/delete(map<string|string[]> headers) returns Response|errorDelete project asynchronously
get api/'3/project/[string projectIdOrKey]/features
Isolated FunctionResource Function
function get api/'3/project/[string projectIdOrKey]/features(map<string|string[]> headers) returns ContainerForProjectFeatures|errorGet project features
Return Type
- ContainerForProjectFeatures|error - Returned if the request is successful
put api/'3/project/[string projectIdOrKey]/features/[string featureKey]
Isolated FunctionResource Function
function put api/'3/project/[string projectIdOrKey]/features/[string featureKey](ProjectFeatureState payload, map<string|string[]> headers) returns ContainerForProjectFeatures|errorSet project feature state
Parameters
- payload ProjectFeatureState - Details of the feature state change
Return Type
- ContainerForProjectFeatures|error - Returned if the request is successful
get api/'3/project/[string projectIdOrKey]/properties
Isolated FunctionResource Function
function get api/'3/project/[string projectIdOrKey]/properties(map<string|string[]> headers) returns PropertyKeys|errorGet project property keys
Return Type
- PropertyKeys|error - Returned if the request is successful
get api/'3/project/[string projectIdOrKey]/properties/[string propertyKey]
Isolated FunctionResource Function
function get api/'3/project/[string projectIdOrKey]/properties/[string propertyKey](map<string|string[]> headers) returns EntityProperty|errorGet project property
Return Type
- EntityProperty|error - Returned if the request is successful
put api/'3/project/[string projectIdOrKey]/properties/[string propertyKey]
Isolated FunctionResource Function
function put api/'3/project/[string projectIdOrKey]/properties/[string propertyKey](json payload, map<string|string[]> headers) returns json|errorSet project property
Parameters
- payload json - The value of the property. The value has to be a valid, non-empty JSON value. The maximum length of the property value is 32768 bytes
Return Type
- json|error - Returned if the project property is updated
delete api/'3/project/[string projectIdOrKey]/properties/[string propertyKey]
Isolated FunctionResource Function
function delete api/'3/project/[string projectIdOrKey]/properties/[string propertyKey](map<string|string[]> headers) returns error?Delete project property
Return Type
- error? - Returned if the project property is deleted
post api/'3/project/[string projectIdOrKey]
Isolated FunctionResource Function
function post api/'3/project/[string projectIdOrKey](map<string|string[]> headers) returns Project|errorget api/'3/project/[string projectIdOrKey]/role
Isolated FunctionResource Function
function get api/'3/project/[string projectIdOrKey]/role(map<string|string[]> headers) returns record { string... }|errorGet project roles for project
get api/'3/project/[string projectIdOrKey]/role/[int id]
Isolated FunctionResource Function
function get api/'3/project/[string projectIdOrKey]/role/[int id](map<string|string[]> headers, *GetProjectRoleQueries queries) returns ProjectRole|errorGet project role for project
Parameters
- queries *GetProjectRoleQueries - Queries to be sent with the request
Return Type
- ProjectRole|error - Returned if the request is successful
put api/'3/project/[string projectIdOrKey]/role/[int id]
Isolated FunctionResource Function
function put api/'3/project/[string projectIdOrKey]/role/[int id](ProjectRoleActorsUpdateBean payload, map<string|string[]> headers) returns ProjectRole|errorSet actors for project role
Parameters
- payload ProjectRoleActorsUpdateBean - The groups or users to associate with the project role for this project. Provide the user account ID, group name, or group ID. As a group's name can change, use of group ID is recommended
Return Type
- ProjectRole|error - Returned if the request is successful. The complete list of actors for the project is returned
post api/'3/project/[string projectIdOrKey]/role/[int id]
Isolated FunctionResource Function
function post api/'3/project/[string projectIdOrKey]/role/[int id](ActorsMap payload, map<string|string[]> headers) returns ProjectRole|errorAdd actors to project role
Parameters
- payload ActorsMap - The groups or users to associate with the project role for this project. Provide the user account ID, group name, or group ID. As a group's name can change, use of group ID is recommended
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
useractor for this project
delete api/'3/project/[string projectIdOrKey]/role/[int id]
Isolated FunctionResource Function
function delete api/'3/project/[string projectIdOrKey]/role/[int id](map<string|string[]> headers, *DeleteActorQueries queries) returns error?Delete actors from project role
Parameters
- queries *DeleteActorQueries - Queries to be sent with the request
Return Type
- error? - Returned if the request is successful
get api/'3/project/[string projectIdOrKey]/roledetails
Isolated FunctionResource Function
function get api/'3/project/[string projectIdOrKey]/roledetails(map<string|string[]> headers, *GetProjectRoleDetailsQueries queries) returns ProjectRoleDetails[]|errorGet project role details
Parameters
- queries *GetProjectRoleDetailsQueries - Queries to be sent with the request
Return Type
- ProjectRoleDetails[]|error - Returned if the request is successful
get api/'3/project/[string projectIdOrKey]/statuses
Isolated FunctionResource Function
function get api/'3/project/[string projectIdOrKey]/statuses(map<string|string[]> headers) returns IssueTypeWithStatus[]|errorGet all statuses for project
Return Type
- IssueTypeWithStatus[]|error - Returned if the request is successful
get api/'3/project/[string projectIdOrKey]/version
Isolated FunctionResource Function
function get api/'3/project/[string projectIdOrKey]/version(map<string|string[]> headers, *GetProjectVersionsPaginatedQueries queries) returns PageBeanVersion|errorGet project versions paginated
Parameters
- queries *GetProjectVersionsPaginatedQueries - Queries to be sent with the request
Return Type
- PageBeanVersion|error - Returned if the request is successful
get api/'3/project/[string projectIdOrKey]/versions
Isolated FunctionResource Function
function get api/'3/project/[string projectIdOrKey]/versions(map<string|string[]> headers, *GetProjectVersionsQueries queries) returns Version[]|errorGet project versions
Parameters
- queries *GetProjectVersionsQueries - Queries to be sent with the request
get api/'3/project/[int projectId]/email
Isolated FunctionResource Function
function get api/'3/project/[int projectId]/email(map<string|string[]> headers) returns ProjectEmailAddress|errorGet project's sender email
Return Type
- ProjectEmailAddress|error - Returned if the request is successful
put api/'3/project/[int projectId]/email
Isolated FunctionResource Function
function put api/'3/project/[int projectId]/email(ProjectEmailAddress payload, map<string|string[]> headers) returns json|errorSet project's sender email
Parameters
- 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
get api/'3/project/[int projectId]/hierarchy
Isolated FunctionResource Function
function get api/'3/project/[int projectId]/hierarchy(map<string|string[]> headers) returns ProjectIssueTypeHierarchy|errorGet project issue type hierarchy
Return Type
- ProjectIssueTypeHierarchy|error - Returned if the request is successful
get api/'3/project/[string projectKeyOrId]/issuesecuritylevelscheme
Isolated FunctionResource Function
function get api/'3/project/[string projectKeyOrId]/issuesecuritylevelscheme(map<string|string[]> headers) returns SecurityScheme|errorGet project issue security scheme
Return Type
- SecurityScheme|error - Returned if the request is successful
get api/'3/project/[string projectKeyOrId]/notificationscheme
Isolated FunctionResource Function
function get api/'3/project/[string projectKeyOrId]/notificationscheme(map<string|string[]> headers, *GetNotificationSchemeForProjectQueries queries) returns NotificationScheme|errorGet project notification scheme
Parameters
- queries *GetNotificationSchemeForProjectQueries - Queries to be sent with the request
Return Type
- NotificationScheme|error - Returned if the request is successful
get api/'3/project/[string projectKeyOrId]/permissionscheme
Isolated FunctionResource Function
function get api/'3/project/[string projectKeyOrId]/permissionscheme(map<string|string[]> headers, *GetAssignedPermissionSchemeQueries queries) returns PermissionScheme|errorGet assigned permission scheme
Parameters
- queries *GetAssignedPermissionSchemeQueries - Queries to be sent with the request
Return Type
- PermissionScheme|error - Returned if the request is successful
put api/'3/project/[string projectKeyOrId]/permissionscheme
Isolated FunctionResource Function
function put api/'3/project/[string projectKeyOrId]/permissionscheme(IdBean payload, map<string|string[]> headers, *AssignPermissionSchemeQueries queries) returns PermissionScheme|errorAssign permission scheme
Parameters
- payload IdBean -
- queries *AssignPermissionSchemeQueries - Queries to be sent with the request
Return Type
- PermissionScheme|error - Returned if the request is successful
get api/'3/project/[string projectKeyOrId]/securitylevel
Isolated FunctionResource Function
function get api/'3/project/[string projectKeyOrId]/securitylevel(map<string|string[]> headers) returns ProjectIssueSecurityLevels|errorGet project issue security levels
Return Type
- ProjectIssueSecurityLevels|error - Returned if the request is successful
get api/'3/projectCategory
Isolated FunctionResource Function
function get api/'3/projectCategory(map<string|string[]> headers) returns ProjectCategory[]|errorGet all project categories
Return Type
- ProjectCategory[]|error - Returned if the request is successful
post api/'3/projectCategory
Isolated FunctionResource Function
function post api/'3/projectCategory(ProjectCategory payload, map<string|string[]> headers) returns ProjectCategory|errorCreate project category
Parameters
- payload ProjectCategory -
Return Type
- ProjectCategory|error - Returned if the request is successful
get api/'3/projectCategory/[int id]
Isolated FunctionResource Function
function get api/'3/projectCategory/[int id](map<string|string[]> headers) returns ProjectCategory|errorGet project category by ID
Return Type
- ProjectCategory|error - Returned if the request is successful
put api/'3/projectCategory/[int id]
Isolated FunctionResource Function
function put api/'3/projectCategory/[int id](ProjectCategory payload, map<string|string[]> headers) returns UpdatedProjectCategory|errorUpdate project category
Parameters
- payload ProjectCategory -
Return Type
- UpdatedProjectCategory|error - Returned if the request is successful
delete api/'3/projectCategory/[int id]
Isolated FunctionResource Function
Delete project category
Return Type
- error? - Returned if the request is successful
get api/'3/projectvalidate/'key
Isolated FunctionResource Function
function get api/'3/projectvalidate/'key(map<string|string[]> headers, *ValidateProjectKeyQueries queries) returns ErrorCollection|errorValidate project key
Parameters
- queries *ValidateProjectKeyQueries - Queries to be sent with the request
Return Type
- ErrorCollection|error - Returned if the request is successful
get api/'3/projectvalidate/validProjectKey
Isolated FunctionResource Function
function get api/'3/projectvalidate/validProjectKey(map<string|string[]> headers, *GetValidProjectKeyQueries queries) returns string|errorGet valid project key
Parameters
- queries *GetValidProjectKeyQueries - Queries to be sent with the request
get api/'3/projectvalidate/validProjectName
Isolated FunctionResource Function
function get api/'3/projectvalidate/validProjectName(map<string|string[]> headers, *GetValidProjectNameQueries queries) returns string|errorGet valid project name
Parameters
- queries *GetValidProjectNameQueries - Queries to be sent with the request
post api/'3/redact
Isolated FunctionResource Function
function post api/'3/redact(BulkRedactionRequest payload, map<string|string[]> headers) returns string|errorRedact
Parameters
- payload BulkRedactionRequest - List of redaction requests
Return Type
get api/'3/redact/status/[string jobId]
Isolated FunctionResource Function
function get api/'3/redact/status/[string jobId](map<string|string[]> headers) returns RedactionJobStatusResponse|errorGet redaction status
Return Type
- RedactionJobStatusResponse|error - Returned if the job status is successfully retrieved
get api/'3/resolution
DeprecatedIsolated FunctionResource Function
function get api/'3/resolution(map<string|string[]> headers) returns Resolution[]|errorGet resolutions
Return Type
- Resolution[]|error - Returned if the request is successful
Deprecated
post api/'3/resolution
Isolated FunctionResource Function
function post api/'3/resolution(CreateResolutionDetails payload, map<string|string[]> headers) returns ResolutionId|errorCreate resolution
Parameters
- payload CreateResolutionDetails -
Return Type
- ResolutionId|error - Returned if the request is successful
put api/'3/resolution/default
Isolated FunctionResource Function
function put api/'3/resolution/default(SetDefaultResolutionRequest payload, map<string|string[]> headers) returns json|errorSet default resolution
Parameters
- payload SetDefaultResolutionRequest -
Return Type
- json|error - Returned if the request is successful
put api/'3/resolution/move
Isolated FunctionResource Function
function put api/'3/resolution/move(ReorderIssueResolutionsRequest payload, map<string|string[]> headers) returns json|errorMove resolutions
Parameters
- payload ReorderIssueResolutionsRequest -
Return Type
- json|error - Returned if the request is successful
get api/'3/resolution/search
Isolated FunctionResource Function
function get api/'3/resolution/search(map<string|string[]> headers, *SearchResolutionsQueries queries) returns PageBeanResolutionJsonBean|errorSearch resolutions
Parameters
- queries *SearchResolutionsQueries - Queries to be sent with the request
Return Type
- PageBeanResolutionJsonBean|error - Returned if the request is successful
get api/'3/resolution/[string id]
Isolated FunctionResource Function
function get api/'3/resolution/[string id](map<string|string[]> headers) returns Resolution|errorGet resolution
Return Type
- Resolution|error - Returned if the request is successful
put api/'3/resolution/[string id]
Isolated FunctionResource Function
function put api/'3/resolution/[string id](UpdateResolutionDetails payload, map<string|string[]> headers) returns json|errorUpdate resolution
Parameters
- payload UpdateResolutionDetails -
Return Type
- json|error - Returned if the request is successful
delete api/'3/resolution/[string id]
Isolated FunctionResource Function
function delete api/'3/resolution/[string id](map<string|string[]> headers, *DeleteResolutionQueries queries) returns Response|errorDelete resolution
Parameters
- queries *DeleteResolutionQueries - Queries to be sent with the request
get api/'3/role
Isolated FunctionResource Function
function get api/'3/role(map<string|string[]> headers) returns ProjectRole[]|errorGet all project roles
Return Type
- ProjectRole[]|error - Returned if the request is successful
post api/'3/role
Isolated FunctionResource Function
function post api/'3/role(CreateUpdateRoleRequestBean payload, map<string|string[]> headers) returns ProjectRole|errorCreate project role
Parameters
- payload CreateUpdateRoleRequestBean -
Return Type
- ProjectRole|error - Returned if the request is successful
get api/'3/role/[int id]
Isolated FunctionResource Function
function get api/'3/role/[int id](map<string|string[]> headers) returns ProjectRole|errorGet project role by ID
Return Type
- ProjectRole|error - Returned if the request is successful
put api/'3/role/[int id]
Isolated FunctionResource Function
function put api/'3/role/[int id](CreateUpdateRoleRequestBean payload, map<string|string[]> headers) returns ProjectRole|errorFully update project role
Parameters
- payload CreateUpdateRoleRequestBean -
Return Type
- ProjectRole|error - Returned if the request is successful
post api/'3/role/[int id]
Isolated FunctionResource Function
function post api/'3/role/[int id](CreateUpdateRoleRequestBean payload, map<string|string[]> headers) returns ProjectRole|errorPartial update project role
Parameters
- payload CreateUpdateRoleRequestBean -
Return Type
- ProjectRole|error - Returned if the request is successful
delete api/'3/role/[int id]
Isolated FunctionResource Function
function delete api/'3/role/[int id](map<string|string[]> headers, *DeleteProjectRoleQueries queries) returns error?Delete project role
Parameters
- queries *DeleteProjectRoleQueries - Queries to be sent with the request
Return Type
- error? - Returned if the request is successful
get api/'3/role/[int id]/actors
Isolated FunctionResource Function
function get api/'3/role/[int id]/actors(map<string|string[]> headers) returns ProjectRole|errorGet default actors for project role
Return Type
- ProjectRole|error - Returned if the request is successful
post api/'3/role/[int id]/actors
Isolated FunctionResource Function
function post api/'3/role/[int id]/actors(ActorInputBean payload, map<string|string[]> headers) returns ProjectRole|errorAdd default actors to project role
Parameters
- payload ActorInputBean -
Return Type
- ProjectRole|error - Returned if the request is successful
delete api/'3/role/[int id]/actors
Isolated FunctionResource Function
function delete api/'3/role/[int id]/actors(map<string|string[]> headers, *DeleteProjectRoleActorsFromRoleQueries queries) returns ProjectRole|errorDelete default actors from project role
Parameters
- queries *DeleteProjectRoleActorsFromRoleQueries - Queries to be sent with the request
Return Type
- ProjectRole|error - Returned if the request is successful
get api/'3/screens
Isolated FunctionResource Function
function get api/'3/screens(map<string|string[]> headers, *GetScreensQueries queries) returns PageBeanScreen|errorGet screens
Parameters
- queries *GetScreensQueries - Queries to be sent with the request
Return Type
- PageBeanScreen|error - Returned if the request is successful
post api/'3/screens
Isolated FunctionResource Function
function post api/'3/screens(ScreenDetails payload, map<string|string[]> headers) returns Screen|errorCreate screen
Parameters
- payload ScreenDetails -
post api/'3/screens/addToDefault/[string fieldId]
Isolated FunctionResource Function
function post api/'3/screens/addToDefault/[string fieldId](map<string|string[]> headers) returns json|errorAdd field to default screen
Return Type
- json|error - Returned if the request is successful
get api/'3/screens/tabs
Isolated FunctionResource Function
function get api/'3/screens/tabs(map<string|string[]> headers, *GetBulkScreenTabsQueries queries) returns json|errorGet bulk screen tabs
Parameters
- queries *GetBulkScreenTabsQueries - Queries to be sent with the request
Return Type
- json|error - Returned if the request is successful
put api/'3/screens/[int screenId]
Isolated FunctionResource Function
function put api/'3/screens/[int screenId](UpdateScreenDetails payload, map<string|string[]> headers) returns Screen|errorUpdate screen
Parameters
- payload UpdateScreenDetails -
delete api/'3/screens/[int screenId]
Isolated FunctionResource Function
Delete screen
Return Type
- error? - Returned if the request is successful
get api/'3/screens/[int screenId]/availableFields
Isolated FunctionResource Function
function get api/'3/screens/[int screenId]/availableFields(map<string|string[]> headers) returns ScreenableField[]|errorGet available screen fields
Return Type
- ScreenableField[]|error - Returned if the request is successful
get api/'3/screens/[int screenId]/tabs
Isolated FunctionResource Function
function get api/'3/screens/[int screenId]/tabs(map<string|string[]> headers, *GetAllScreenTabsQueries queries) returns ScreenableTab[]|errorGet all screen tabs
Parameters
- queries *GetAllScreenTabsQueries - Queries to be sent with the request
Return Type
- ScreenableTab[]|error - Returned if the request is successful
post api/'3/screens/[int screenId]/tabs
Isolated FunctionResource Function
function post api/'3/screens/[int screenId]/tabs(ScreenableTab payload, map<string|string[]> headers) returns ScreenableTab|errorCreate screen tab
Parameters
- payload ScreenableTab -
Return Type
- ScreenableTab|error - Returned if the request is successful
put api/'3/screens/[int screenId]/tabs/[int tabId]
Isolated FunctionResource Function
function put api/'3/screens/[int screenId]/tabs/[int tabId](ScreenableTab payload, map<string|string[]> headers) returns ScreenableTab|errorUpdate screen tab
Parameters
- payload ScreenableTab -
Return Type
- ScreenableTab|error - Returned if the request is successful
delete api/'3/screens/[int screenId]/tabs/[int tabId]
Isolated FunctionResource Function
function delete api/'3/screens/[int screenId]/tabs/[int tabId](map<string|string[]> headers) returns error?Delete screen tab
Return Type
- error? - Returned if the request is successful
get api/'3/screens/[int screenId]/tabs/[int tabId]/fields
Isolated FunctionResource Function
function get api/'3/screens/[int screenId]/tabs/[int tabId]/fields(map<string|string[]> headers, *GetAllScreenTabFieldsQueries queries) returns ScreenableField[]|errorGet all screen tab fields
Parameters
- queries *GetAllScreenTabFieldsQueries - Queries to be sent with the request
Return Type
- ScreenableField[]|error - Returned if the request is successful
post api/'3/screens/[int screenId]/tabs/[int tabId]/fields
Isolated FunctionResource Function
function post api/'3/screens/[int screenId]/tabs/[int tabId]/fields(AddFieldBean payload, map<string|string[]> headers) returns ScreenableField|errorAdd screen tab field
Parameters
- payload AddFieldBean -
Return Type
- ScreenableField|error - Returned if the request is successful
delete api/'3/screens/[int screenId]/tabs/[int tabId]/fields/[string id]
Isolated FunctionResource Function
function delete api/'3/screens/[int screenId]/tabs/[int tabId]/fields/[string id](map<string|string[]> headers) returns error?Remove screen tab field
Return Type
- error? - Returned if the request is successful
post api/'3/screens/[int screenId]/tabs/[int tabId]/fields/[string id]/move
Isolated FunctionResource Function
function post api/'3/screens/[int screenId]/tabs/[int tabId]/fields/[string id]/move(MoveFieldBean payload, map<string|string[]> headers) returns json|errorMove screen tab field
Parameters
- payload MoveFieldBean -
Return Type
- json|error - Returned if the request is successful
post api/'3/screens/[int screenId]/tabs/[int tabId]/move/[int:Signed32 pos]
Isolated FunctionResource Function
function post api/'3/screens/[int screenId]/tabs/[int tabId]/move/[int:Signed32 pos](map<string|string[]> headers) returns json|errorMove screen tab
Return Type
- json|error - Returned if the request is successful
get api/'3/screenscheme
Isolated FunctionResource Function
function get api/'3/screenscheme(map<string|string[]> headers, *GetScreenSchemesQueries queries) returns PageBeanScreenScheme|errorGet screen schemes
Parameters
- queries *GetScreenSchemesQueries - Queries to be sent with the request
Return Type
- PageBeanScreenScheme|error - Returned if the request is successful
post api/'3/screenscheme
Isolated FunctionResource Function
function post api/'3/screenscheme(ScreenSchemeDetails payload, map<string|string[]> headers) returns ScreenSchemeId|errorCreate screen scheme
Parameters
- payload ScreenSchemeDetails -
Return Type
- ScreenSchemeId|error - Returned if the request is successful
put api/'3/screenscheme/[string screenSchemeId]
Isolated FunctionResource Function
function put api/'3/screenscheme/[string screenSchemeId](UpdateScreenSchemeDetails payload, map<string|string[]> headers) returns json|errorUpdate screen scheme
Parameters
- payload UpdateScreenSchemeDetails - The screen scheme update details
Return Type
- json|error - Returned if the request is successful
delete api/'3/screenscheme/[string screenSchemeId]
Isolated FunctionResource Function
function delete api/'3/screenscheme/[string screenSchemeId](map<string|string[]> headers) returns error?Delete screen scheme
Return Type
- error? - Returned if the screen scheme is deleted
get api/'3/search
DeprecatedIsolated FunctionResource Function
function get api/'3/search(map<string|string[]> headers, *SearchForIssuesUsingJqlQueries queries) returns SearchResults|errorCurrently being removed. Search for issues using JQL (GET)
Parameters
- queries *SearchForIssuesUsingJqlQueries - Queries to be sent with the request
Return Type
- SearchResults|error - Returned if the request is successful
Deprecated
post api/'3/search
DeprecatedIsolated FunctionResource Function
function post api/'3/search(SearchRequestBean payload, map<string|string[]> headers) returns SearchResults|errorCurrently being removed. 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
Deprecated
post api/'3/search/approximate-count
Isolated FunctionResource Function
function post api/'3/search/approximate\-count(JQLCountRequestBean payload, map<string|string[]> headers) returns JQLCountResultsBean|errorCount issues using JQL
Parameters
- payload JQLCountRequestBean - A JSON object containing the search request
Return Type
- JQLCountResultsBean|error - Returned if the request is successful
get api/'3/search/jql
Isolated FunctionResource Function
function get api/'3/search/jql(map<string|string[]> headers, *SearchAndReconsileIssuesUsingJqlQueries queries) returns SearchAndReconcileResults|errorSearch for issues using JQL enhanced search (GET)
Parameters
- queries *SearchAndReconsileIssuesUsingJqlQueries - Queries to be sent with the request
Return Type
- SearchAndReconcileResults|error - Returned if the request is successful
post api/'3/search/jql
Isolated FunctionResource Function
function post api/'3/search/jql(SearchAndReconcileRequestBean payload, map<string|string[]> headers) returns SearchAndReconcileResults|errorSearch for issues using JQL enhanced search (POST)
Parameters
- payload SearchAndReconcileRequestBean -
Return Type
- SearchAndReconcileResults|error - Returned if the request is successful
get api/'3/securitylevel/[string id]
Isolated FunctionResource Function
function get api/'3/securitylevel/[string id](map<string|string[]> headers) returns SecurityLevel|errorGet issue security level
Return Type
- SecurityLevel|error - Returned if the request is successful
get api/'3/serverInfo
Isolated FunctionResource Function
function get api/'3/serverInfo(map<string|string[]> headers) returns ServerInformation|errorGet Jira instance info
Return Type
- ServerInformation|error - Returned if the request is successful
get api/'3/settings/columns
Isolated FunctionResource Function
function get api/'3/settings/columns(map<string|string[]> headers) returns ColumnItem[]|errorGet issue navigator default columns
Return Type
- ColumnItem[]|error - Returned if the request is successful
put api/'3/settings/columns
Isolated FunctionResource Function
Set issue navigator default columns
Parameters
- request Request - A navigable field value
Return Type
- error? - Returned if the request is successful
get api/'3/status
Isolated FunctionResource Function
function get api/'3/status(map<string|string[]> headers) returns StatusDetails[]|errorGet all statuses
Return Type
- StatusDetails[]|error - Returned if the request is successful
get api/'3/status/[string idOrName]
Isolated FunctionResource Function
function get api/'3/status/[string idOrName](map<string|string[]> headers) returns StatusDetails|errorGet status
Return Type
- StatusDetails|error - Returned if the request is successful
get api/'3/statuscategory
Isolated FunctionResource Function
function get api/'3/statuscategory(map<string|string[]> headers) returns StatusCategory[]|errorGet all status categories
Return Type
- StatusCategory[]|error - Returned if the request is successful
get api/'3/statuscategory/[string idOrKey]
Isolated FunctionResource Function
function get api/'3/statuscategory/[string idOrKey](map<string|string[]> headers) returns StatusCategory|errorGet status category
Return Type
- StatusCategory|error - Returned if the request is successful
get api/'3/statuses
Isolated FunctionResource Function
function get api/'3/statuses(map<string|string[]> headers, *GetStatusesByIdQueries queries) returns JiraStatus[]|errorBulk get statuses
Parameters
- queries *GetStatusesByIdQueries - Queries to be sent with the request
Return Type
- JiraStatus[]|error - Returned if the request is successful
put api/'3/statuses
Isolated FunctionResource Function
function put api/'3/statuses(StatusUpdateRequest payload, map<string|string[]> headers) returns json|errorBulk update statuses
Parameters
- payload StatusUpdateRequest - The list of statuses that will be updated
Return Type
- json|error - Returned if the request is successful
post api/'3/statuses
Isolated FunctionResource Function
function post api/'3/statuses(StatusCreateRequest payload, map<string|string[]> headers) returns JiraStatus[]|errorBulk create statuses
Parameters
- payload StatusCreateRequest - Details of the statuses being created and their scope
Return Type
- JiraStatus[]|error - Returned if the request is successful
delete api/'3/statuses
Isolated FunctionResource Function
function delete api/'3/statuses(map<string|string[]> headers, *DeleteStatusesByIdQueries queries) returns json|errorBulk delete Statuses
Parameters
- queries *DeleteStatusesByIdQueries - Queries to be sent with the request
Return Type
- json|error - Returned if the request is successful
get api/'3/statuses/search
Isolated FunctionResource Function
function get api/'3/statuses/search(map<string|string[]> headers, *SearchQueries queries) returns PageOfStatuses|errorSearch statuses paginated
Parameters
- queries *SearchQueries - Queries to be sent with the request
Return Type
- PageOfStatuses|error - Returned if the request is successful
get api/'3/statuses/[string statusId]/project/[string projectId]/issueTypeUsages
Isolated FunctionResource Function
function get api/'3/statuses/[string statusId]/project/[string projectId]/issueTypeUsages(map<string|string[]> headers, *GetProjectIssueTypeUsagesForStatusQueries queries) returns StatusProjectIssueTypeUsageDTO|errorGet issue type usages by status and project
Parameters
- queries *GetProjectIssueTypeUsagesForStatusQueries - Queries to be sent with the request
Return Type
- StatusProjectIssueTypeUsageDTO|error - Returned if the request is successful
get api/'3/statuses/[string statusId]/projectUsages
Isolated FunctionResource Function
function get api/'3/statuses/[string statusId]/projectUsages(map<string|string[]> headers, *GetProjectUsagesForStatusQueries queries) returns StatusProjectUsageDTO|errorGet project usages by status
Parameters
- queries *GetProjectUsagesForStatusQueries - Queries to be sent with the request
Return Type
- StatusProjectUsageDTO|error - Returned if the request is successful
get api/'3/statuses/[string statusId]/workflowUsages
Isolated FunctionResource Function
function get api/'3/statuses/[string statusId]/workflowUsages(map<string|string[]> headers, *GetWorkflowUsagesForStatusQueries queries) returns StatusWorkflowUsageDTO|errorGet workflow usages by status
Parameters
- queries *GetWorkflowUsagesForStatusQueries - Queries to be sent with the request
Return Type
- StatusWorkflowUsageDTO|error - Returned if the request is successful
get api/'3/task/[string taskId]
Isolated FunctionResource Function
function get api/'3/task/[string taskId](map<string|string[]> headers) returns TaskProgressBeanObject|errorGet task
Return Type
- TaskProgressBeanObject|error - Returned if the request is successful
post api/'3/task/[string taskId]/cancel
Isolated FunctionResource Function
Cancel task
Return Type
- json|error - Returned if the request is successful
get api/'3/uiModifications
Isolated FunctionResource Function
function get api/'3/uiModifications(map<string|string[]> headers, *GetUiModificationsQueries queries) returns PageBeanUiModificationDetails|errorGet UI modifications
Parameters
- queries *GetUiModificationsQueries - Queries to be sent with the request
Return Type
- PageBeanUiModificationDetails|error - Returned if the request is successful
post api/'3/uiModifications
Isolated FunctionResource Function
function post api/'3/uiModifications(CreateUiModificationDetails payload, map<string|string[]> headers) returns UiModificationIdentifiers|errorCreate UI modification
Parameters
- payload CreateUiModificationDetails - Details of the UI modification
Return Type
- UiModificationIdentifiers|error - Returned if the UI modification is created
put api/'3/uiModifications/[string uiModificationId]
Isolated FunctionResource Function
function put api/'3/uiModifications/[string uiModificationId](UpdateUiModificationDetails payload, map<string|string[]> headers) returns json|errorUpdate UI modification
Parameters
- payload UpdateUiModificationDetails - Details of the UI modification
Return Type
- json|error - Returned if the UI modification is updated
delete api/'3/uiModifications/[string uiModificationId]
Isolated FunctionResource Function
function delete api/'3/uiModifications/[string uiModificationId](map<string|string[]> headers) returns json|errorDelete UI modification
Return Type
- json|error - Returned if the UI modification is deleted
get api/'3/universal_avatar/'type/["project"|"issuetype"|"priority" 'type]/owner/[string entityId]
Isolated FunctionResource Function
function get api/'3/universal_avatar/'type/["project"|"issuetype"|"priority" 'type]/owner/[string entityId](map<string|string[]> headers) returns Avatars|errorGet avatars
post api/'3/universal_avatar/'type/["project"|"issuetype"|"priority" 'type]/owner/[string entityId]
Isolated FunctionResource Function
function post api/'3/universal_avatar/'type/["project"|"issuetype"|"priority" 'type]/owner/[string entityId](Request request, map<string|string[]> headers, *StoreAvatarQueries queries) returns Avatar|errorLoad avatar
delete api/'3/universal_avatar/'type/["project"|"issuetype"|"priority" 'type]/owner/[string owningObjectId]/avatar/[int id]
Isolated FunctionResource Function
function delete api/'3/universal_avatar/'type/["project"|"issuetype"|"priority" 'type]/owner/[string owningObjectId]/avatar/[int id](map<string|string[]> headers) returns error?Delete avatar
Return Type
- error? - Returned if the request is successful
get api/'3/universal_avatar/view/'type/["issuetype"|"project"|"priority" 'type]
Isolated FunctionResource Function
function get api/'3/universal_avatar/view/'type/["issuetype"|"project"|"priority" 'type](map<string|string[]> headers, *GetAvatarImageByTypeQueries queries) returns StreamingResponseBody|errorGet avatar image by type
Parameters
- queries *GetAvatarImageByTypeQueries - Queries to be sent with the request
Return Type
- StreamingResponseBody|error - Returned if the request is successful
get api/'3/universal_avatar/view/'type/["issuetype"|"project"|"priority" 'type]/avatar/[int id]
Isolated FunctionResource Function
function get api/'3/universal_avatar/view/'type/["issuetype"|"project"|"priority" 'type]/avatar/[int id](map<string|string[]> headers, *GetAvatarImageByIDQueries queries) returns StreamingResponseBody|errorGet avatar image by ID
Parameters
- queries *GetAvatarImageByIDQueries - Queries to be sent with the request
Return Type
- StreamingResponseBody|error - Returned if the request is successful
get api/'3/universal_avatar/view/'type/["issuetype"|"project"|"priority" 'type]/owner/[string entityId]
Isolated FunctionResource Function
function get api/'3/universal_avatar/view/'type/["issuetype"|"project"|"priority" 'type]/owner/[string entityId](map<string|string[]> headers, *GetAvatarImageByOwnerQueries queries) returns StreamingResponseBody|errorGet avatar image by owner
Parameters
- queries *GetAvatarImageByOwnerQueries - Queries to be sent with the request
Return Type
- StreamingResponseBody|error - Returned if the request is successful
get api/'3/user
Isolated FunctionResource Function
Get user
Parameters
- queries *GetUserQueries - Queries to be sent with the request
post api/'3/user
Isolated FunctionResource Function
Create user
Parameters
- payload NewUserDetails - Details about the user to be created
delete api/'3/user
Isolated FunctionResource Function
function delete api/'3/user(map<string|string[]> headers, *RemoveUserQueries queries) returns error?Delete user
Parameters
- queries *RemoveUserQueries - Queries to be sent with the request
Return Type
- error? - Returned if the request is successful
get api/'3/user/assignable/multiProjectSearch
Isolated FunctionResource Function
function get api/'3/user/assignable/multiProjectSearch(map<string|string[]> headers, *FindBulkAssignableUsersQueries queries) returns User[]|errorFind users assignable to projects
Parameters
- queries *FindBulkAssignableUsersQueries - Queries to be sent with the request
get api/'3/user/assignable/search
Isolated FunctionResource Function
function get api/'3/user/assignable/search(map<string|string[]> headers, *FindAssignableUsersQueries queries) returns User[]|errorFind users assignable to issues
Parameters
- queries *FindAssignableUsersQueries - Queries to be sent with the request
get api/'3/user/bulk
Isolated FunctionResource Function
function get api/'3/user/bulk(map<string|string[]> headers, *BulkGetUsersQueries queries) returns PageBeanUser|errorBulk get users
Parameters
- queries *BulkGetUsersQueries - Queries to be sent with the request
Return Type
- PageBeanUser|error - Returned if the request is successful
get api/'3/user/bulk/migration
Isolated FunctionResource Function
function get api/'3/user/bulk/migration(map<string|string[]> headers, *BulkGetUsersMigrationQueries queries) returns UserMigrationBean[]|errorGet account IDs for users
Parameters
- queries *BulkGetUsersMigrationQueries - Queries to be sent with the request
Return Type
- UserMigrationBean[]|error - Returned if the request is successful
get api/'3/user/columns
Isolated FunctionResource Function
function get api/'3/user/columns(map<string|string[]> headers, *GetUserDefaultColumnsQueries queries) returns ColumnItem[]|errorGet user default columns
Parameters
- queries *GetUserDefaultColumnsQueries - Queries to be sent with the request
Return Type
- ColumnItem[]|error - Returned if the request is successful
put api/'3/user/columns
Isolated FunctionResource Function
function put api/'3/user/columns(Request request, map<string|string[]> headers, *SetUserColumnsQueries queries) returns json|errorSet user default columns
Parameters
- request Request - The ID of a column to set. To set multiple columns, send multiple
columnsparameters
- queries *SetUserColumnsQueries - Queries to be sent with the request
Return Type
- json|error - Returned if the request is successful
delete api/'3/user/columns
Isolated FunctionResource Function
function delete api/'3/user/columns(map<string|string[]> headers, *ResetUserColumnsQueries queries) returns error?Reset user default columns
Parameters
- queries *ResetUserColumnsQueries - Queries to be sent with the request
Return Type
- error? - Returned if the request is successful
get api/'3/user/email
Isolated FunctionResource Function
function get api/'3/user/email(map<string|string[]> headers, *GetUserEmailQueries queries) returns UnrestrictedUserEmail|errorGet user email
Parameters
- queries *GetUserEmailQueries - Queries to be sent with the request
Return Type
- UnrestrictedUserEmail|error - Returned if the request is successful
get api/'3/user/email/bulk
Isolated FunctionResource Function
function get api/'3/user/email/bulk(map<string|string[]> headers, *GetUserEmailBulkQueries queries) returns UnrestrictedUserEmail|errorGet user email bulk
Parameters
- queries *GetUserEmailBulkQueries - Queries to be sent with the request
Return Type
- UnrestrictedUserEmail|error - Returned if the request is successful
get api/'3/user/groups
Isolated FunctionResource Function
function get api/'3/user/groups(map<string|string[]> headers, *GetUserGroupsQueries queries) returns GroupName[]|errorGet user groups
Parameters
- queries *GetUserGroupsQueries - Queries to be sent with the request
get api/'3/user/nav4-opt-property/[string propertyKey]
Isolated FunctionResource Function
function get api/'3/user/nav4\-opt\-property/[string propertyKey](map<string|string[]> headers, *GetUserNavPropertyQueries queries) returns UserNavPropertyJsonBean|errorGet user nav property
Parameters
- queries *GetUserNavPropertyQueries - Queries to be sent with the request
Return Type
- UserNavPropertyJsonBean|error - Returned if the request is successful
put api/'3/user/nav4-opt-property/[string propertyKey]
Isolated FunctionResource Function
function put api/'3/user/nav4\-opt\-property/[string propertyKey](json payload, map<string|string[]> headers, *SetUserNavPropertyQueries queries) returns json|errorSet user nav property
Parameters
- payload json - The value of the property. The value has to be a boolean JSON value. The maximum length of the property value is 32768 bytes
- queries *SetUserNavPropertyQueries - Queries to be sent with the request
Return Type
- json|error - Returned if the user property is updated/created
get api/'3/user/permission/search
Isolated FunctionResource Function
function get api/'3/user/permission/search(map<string|string[]> headers, *FindUsersWithAllPermissionsQueries queries) returns User[]|errorFind users with permissions
Parameters
- queries *FindUsersWithAllPermissionsQueries - Queries to be sent with the request
get api/'3/user/picker
Isolated FunctionResource Function
function get api/'3/user/picker(map<string|string[]> headers, *FindUsersForPickerQueries queries) returns FoundUsers|errorFind users for picker
Parameters
- queries *FindUsersForPickerQueries - Queries to be sent with the request
Return Type
- FoundUsers|error - Returned if the request is successful
get api/'3/user/properties
Isolated FunctionResource Function
function get api/'3/user/properties(map<string|string[]> headers, *GetUserPropertyKeysQueries queries) returns PropertyKeys|errorGet user property keys
Parameters
- queries *GetUserPropertyKeysQueries - Queries to be sent with the request
Return Type
- PropertyKeys|error - Returned if the request is successful
get api/'3/user/properties/[string propertyKey]
Isolated FunctionResource Function
function get api/'3/user/properties/[string propertyKey](map<string|string[]> headers, *GetUserPropertyQueries queries) returns EntityProperty|errorGet user property
Parameters
- queries *GetUserPropertyQueries - Queries to be sent with the request
Return Type
- EntityProperty|error - Returned if the request is successful
put api/'3/user/properties/[string propertyKey]
Isolated FunctionResource Function
function put api/'3/user/properties/[string propertyKey](json payload, map<string|string[]> headers, *SetUserPropertyQueries queries) returns json|errorSet user property
Parameters
- payload json - The value of the property. The value has to be a valid, non-empty JSON value. The maximum length of the property value is 32768 bytes
- queries *SetUserPropertyQueries - Queries to be sent with the request
Return Type
- json|error - Returned if the user property is updated
delete api/'3/user/properties/[string propertyKey]
Isolated FunctionResource Function
function delete api/'3/user/properties/[string propertyKey](map<string|string[]> headers, *DeleteUserPropertyQueries queries) returns error?Delete user property
Parameters
- queries *DeleteUserPropertyQueries - Queries to be sent with the request
Return Type
- error? - Returned if the user property is deleted
get api/'3/user/search
Isolated FunctionResource Function
function get api/'3/user/search(map<string|string[]> headers, *FindUsersQueries queries) returns User[]|errorFind users
Parameters
- queries *FindUsersQueries - Queries to be sent with the request
get api/'3/user/search/query
Isolated FunctionResource Function
function get api/'3/user/search/query(map<string|string[]> headers, *FindUsersByQueryQueries queries) returns PageBeanUser|errorFind users by query
Parameters
- queries *FindUsersByQueryQueries - Queries to be sent with the request
Return Type
- PageBeanUser|error - Returned if the request is successful
get api/'3/user/search/query/'key
Isolated FunctionResource Function
function get api/'3/user/search/query/'key(map<string|string[]> headers, *FindUserKeysByQueryQueries queries) returns PageBeanUserKey|errorFind user keys by query
Parameters
- queries *FindUserKeysByQueryQueries - Queries to be sent with the request
Return Type
- PageBeanUserKey|error - Returned if the request is successful
get api/'3/user/viewissue/search
Isolated FunctionResource Function
function get api/'3/user/viewissue/search(map<string|string[]> headers, *FindUsersWithBrowsePermissionQueries queries) returns User[]|errorFind users with browse permission
Parameters
- queries *FindUsersWithBrowsePermissionQueries - Queries to be sent with the request
get api/'3/users
Isolated FunctionResource Function
function get api/'3/users(map<string|string[]> headers, *GetAllUsersDefaultQueries queries) returns User[]|errorGet all users default
Parameters
- queries *GetAllUsersDefaultQueries - Queries to be sent with the request
get api/'3/users/search
Isolated FunctionResource Function
function get api/'3/users/search(map<string|string[]> headers, *GetAllUsersQueries queries) returns User[]|errorGet all users
Parameters
- queries *GetAllUsersQueries - Queries to be sent with the request
post api/'3/version
Isolated FunctionResource Function
Create version
Parameters
- payload Version -
get api/'3/version/[string id]
Isolated FunctionResource Function
function get api/'3/version/[string id](map<string|string[]> headers, *GetVersionQueries queries) returns Version|errorGet version
Parameters
- queries *GetVersionQueries - Queries to be sent with the request
put api/'3/version/[string id]
Isolated FunctionResource Function
function put api/'3/version/[string id](Version payload, map<string|string[]> headers) returns Version|errorUpdate version
Parameters
- payload Version -
delete api/'3/version/[string id]
DeprecatedIsolated FunctionResource Function
function delete api/'3/version/[string id](map<string|string[]> headers, *DeleteVersionQueries queries) returns error?Delete version
Parameters
- queries *DeleteVersionQueries - Queries to be sent with the request
Return Type
- error? - Returned if the version is deleted
Deprecated
put api/'3/version/[string id]/mergeto/[string moveIssuesTo]
Isolated FunctionResource Function
function put api/'3/version/[string id]/mergeto/[string moveIssuesTo](map<string|string[]> headers) returns json|errorMerge versions
Return Type
- json|error - Returned if the version is deleted
post api/'3/version/[string id]/move
Isolated FunctionResource Function
function post api/'3/version/[string id]/move(VersionMoveBean payload, map<string|string[]> headers) returns Version|errorMove version
Parameters
- payload VersionMoveBean -
get api/'3/version/[string id]/relatedIssueCounts
Isolated FunctionResource Function
function get api/'3/version/[string id]/relatedIssueCounts(map<string|string[]> headers) returns VersionIssueCounts|errorGet version's related issues count
Return Type
- VersionIssueCounts|error - Returned if the request is successful
get api/'3/version/[string id]/relatedwork
Isolated FunctionResource Function
function get api/'3/version/[string id]/relatedwork(map<string|string[]> headers) returns VersionRelatedWork[]|errorGet related work
Return Type
- VersionRelatedWork[]|error - Returned if the request is successful
put api/'3/version/[string id]/relatedwork
Isolated FunctionResource Function
function put api/'3/version/[string id]/relatedwork(VersionRelatedWork payload, map<string|string[]> headers) returns VersionRelatedWork|errorUpdate related work
Parameters
- payload VersionRelatedWork -
Return Type
- VersionRelatedWork|error - Returned if the request is successful together with updated related work
post api/'3/version/[string id]/relatedwork
Isolated FunctionResource Function
function post api/'3/version/[string id]/relatedwork(VersionRelatedWork payload, map<string|string[]> headers) returns VersionRelatedWork|errorCreate related work
Parameters
- payload VersionRelatedWork -
Return Type
- VersionRelatedWork|error - Returned if the request is successful
post api/'3/version/[string id]/removeAndSwap
Isolated FunctionResource Function
function post api/'3/version/[string id]/removeAndSwap(DeleteAndReplaceVersionBean payload, map<string|string[]> headers) returns json|errorDelete and replace version
Parameters
- payload DeleteAndReplaceVersionBean -
Return Type
- json|error - Returned if the version is deleted
get api/'3/version/[string id]/unresolvedIssueCount
Isolated FunctionResource Function
function get api/'3/version/[string id]/unresolvedIssueCount(map<string|string[]> headers) returns VersionUnresolvedIssuesCount|errorGet version's unresolved issues count
Return Type
- VersionUnresolvedIssuesCount|error - Returned if the request is successful
delete api/'3/version/[string versionId]/relatedwork/[string relatedWorkId]
Isolated FunctionResource Function
function delete api/'3/version/[string versionId]/relatedwork/[string relatedWorkId](map<string|string[]> headers) returns error?Delete related work
Return Type
- error? - Returned if the related work is deleted
get api/'3/webhook
Isolated FunctionResource Function
function get api/'3/webhook(map<string|string[]> headers, *GetDynamicWebhooksForAppQueries queries) returns PageBeanWebhook|errorGet dynamic webhooks for app
Parameters
- queries *GetDynamicWebhooksForAppQueries - Queries to be sent with the request
Return Type
- PageBeanWebhook|error - Returned if the request is successful
post api/'3/webhook
Isolated FunctionResource Function
function post api/'3/webhook(WebhookRegistrationDetails payload, map<string|string[]> headers) returns ContainerForRegisteredWebhooks|errorRegister dynamic webhooks
Parameters
- payload WebhookRegistrationDetails -
Return Type
- ContainerForRegisteredWebhooks|error - Returned if the request is successful
delete api/'3/webhook
Isolated FunctionResource Function
function delete api/'3/webhook(ContainerForWebhookIDs payload, map<string|string[]> headers) returns error?Delete webhooks by ID
Parameters
- payload ContainerForWebhookIDs -
Return Type
- error? - Returned if the request is successful
get api/'3/webhook/failed
Isolated FunctionResource Function
function get api/'3/webhook/failed(map<string|string[]> headers, *GetFailedWebhooksQueries queries) returns FailedWebhooks|errorGet failed webhooks
Parameters
- queries *GetFailedWebhooksQueries - Queries to be sent with the request
Return Type
- FailedWebhooks|error - Returned if the request is successful
put api/'3/webhook/refresh
Isolated FunctionResource Function
function put api/'3/webhook/refresh(ContainerForWebhookIDs payload, map<string|string[]> headers) returns WebhooksExpirationDate|errorExtend webhook life
Parameters
- payload ContainerForWebhookIDs -
Return Type
- WebhooksExpirationDate|error - Returned if the request is successful
get api/'3/workflow
DeprecatedIsolated FunctionResource Function
function get api/'3/workflow(map<string|string[]> headers, *GetAllWorkflowsQueries queries) returns DeprecatedWorkflow[]|errorGet all workflows
Parameters
- queries *GetAllWorkflowsQueries - Queries to be sent with the request
Return Type
- DeprecatedWorkflow[]|error - Returned if the request is successful
Deprecated
post api/'3/workflow
DeprecatedIsolated FunctionResource Function
function post api/'3/workflow(CreateWorkflowDetails payload, map<string|string[]> headers) returns WorkflowIDs|errorCreate workflow
Parameters
- payload CreateWorkflowDetails - The workflow details
Return Type
- WorkflowIDs|error - Returned if the workflow is created
Deprecated
get api/'3/workflow/rule/config
Isolated FunctionResource Function
function get api/'3/workflow/rule/config(map<string|string[]> headers, *GetWorkflowTransitionRuleConfigurationsQueries queries) returns PageBeanWorkflowTransitionRules|errorGet workflow transition rule configurations
Parameters
- queries *GetWorkflowTransitionRuleConfigurationsQueries - Queries to be sent with the request
Return Type
- PageBeanWorkflowTransitionRules|error - Returned if the request is successful
put api/'3/workflow/rule/config
Isolated FunctionResource Function
function put api/'3/workflow/rule/config(WorkflowTransitionRulesUpdate payload, map<string|string[]> headers) returns WorkflowTransitionRulesUpdateErrors|errorUpdate workflow transition rule configurations
Parameters
- payload WorkflowTransitionRulesUpdate -
Return Type
- WorkflowTransitionRulesUpdateErrors|error - Returned if the request is successful
put api/'3/workflow/rule/config/delete
Isolated FunctionResource Function
function put api/'3/workflow/rule/config/delete(WorkflowsWithTransitionRulesDetails payload, map<string|string[]> headers) returns WorkflowTransitionRulesUpdateErrors|errorDelete workflow transition rule configurations
Parameters
- payload WorkflowsWithTransitionRulesDetails -
Return Type
- WorkflowTransitionRulesUpdateErrors|error - Returned if the request is successful
get api/'3/workflow/search
DeprecatedIsolated FunctionResource Function
function get api/'3/workflow/search(map<string|string[]> headers, *GetWorkflowsPaginatedQueries queries) returns PageBeanWorkflow|errorGet workflows paginated
Parameters
- queries *GetWorkflowsPaginatedQueries - Queries to be sent with the request
Return Type
- PageBeanWorkflow|error - Returned if the request is successful
Deprecated
get api/'3/workflow/transitions/[int transitionId]/properties
DeprecatedIsolated FunctionResource Function
function get api/'3/workflow/transitions/[int transitionId]/properties(map<string|string[]> headers, *GetWorkflowTransitionPropertiesQueries queries) returns WorkflowTransitionProperty|errorGet workflow transition properties
Parameters
- queries *GetWorkflowTransitionPropertiesQueries - Queries to be sent with the request
Return Type
- WorkflowTransitionProperty|error - 200 response
Deprecated
put api/'3/workflow/transitions/[int transitionId]/properties
DeprecatedIsolated FunctionResource Function
function put api/'3/workflow/transitions/[int transitionId]/properties(WorkflowTransitionProperty payload, map<string|string[]> headers, *UpdateWorkflowTransitionPropertyQueries queries) returns WorkflowTransitionProperty|error?Update workflow transition property
Parameters
- payload WorkflowTransitionProperty -
- queries *UpdateWorkflowTransitionPropertyQueries - Queries to be sent with the request
Return Type
- WorkflowTransitionProperty|error? - 200 response
Deprecated
post api/'3/workflow/transitions/[int transitionId]/properties
DeprecatedIsolated FunctionResource Function
function post api/'3/workflow/transitions/[int transitionId]/properties(WorkflowTransitionProperty payload, map<string|string[]> headers, *CreateWorkflowTransitionPropertyQueries queries) returns WorkflowTransitionProperty|errorCreate workflow transition property
Parameters
- payload WorkflowTransitionProperty -
- queries *CreateWorkflowTransitionPropertyQueries - Queries to be sent with the request
Return Type
- WorkflowTransitionProperty|error - 200 response
Deprecated
delete api/'3/workflow/transitions/[int transitionId]/properties
DeprecatedIsolated FunctionResource Function
function delete api/'3/workflow/transitions/[int transitionId]/properties(map<string|string[]> headers, *DeleteWorkflowTransitionPropertyQueries queries) returns error?Delete workflow transition property
Parameters
- queries *DeleteWorkflowTransitionPropertyQueries - Queries to be sent with the request
Return Type
- error? - 200 response
Deprecated
delete api/'3/workflow/[string entityId]
Isolated FunctionResource Function
Delete inactive workflow
Return Type
- error? - Returned if the workflow is deleted
get api/'3/workflow/[string workflowId]/project/[int projectId]/issueTypeUsages
Isolated FunctionResource Function
function get api/'3/workflow/[string workflowId]/project/[int projectId]/issueTypeUsages(map<string|string[]> headers, *GetWorkflowProjectIssueTypeUsagesQueries queries) returns WorkflowProjectIssueTypeUsageDTO|errorGet issue types in a project that are using a given workflow
Parameters
- queries *GetWorkflowProjectIssueTypeUsagesQueries - Queries to be sent with the request
Return Type
- WorkflowProjectIssueTypeUsageDTO|error - Returned if the request is successful
get api/'3/workflow/[string workflowId]/projectUsages
Isolated FunctionResource Function
function get api/'3/workflow/[string workflowId]/projectUsages(map<string|string[]> headers, *GetProjectUsagesForWorkflowQueries queries) returns WorkflowProjectUsageDTO|errorGet projects using a given workflow
Parameters
- queries *GetProjectUsagesForWorkflowQueries - Queries to be sent with the request
Return Type
- WorkflowProjectUsageDTO|error - Returned if the request is successful
get api/'3/workflow/[string workflowId]/workflowSchemes
Isolated FunctionResource Function
function get api/'3/workflow/[string workflowId]/workflowSchemes(map<string|string[]> headers, *GetWorkflowSchemeUsagesForWorkflowQueries queries) returns WorkflowSchemeUsageDTO|errorGet workflow schemes which are using a given workflow
Parameters
- queries *GetWorkflowSchemeUsagesForWorkflowQueries - Queries to be sent with the request
Return Type
- WorkflowSchemeUsageDTO|error - Returned if the request is successful
post api/'3/workflows
Isolated FunctionResource Function
function post api/'3/workflows(WorkflowReadRequest payload, map<string|string[]> headers, *ReadWorkflowsQueries queries) returns WorkflowReadResponse|errorBulk get workflows
Parameters
- payload WorkflowReadRequest -
- queries *ReadWorkflowsQueries - Queries to be sent with the request
Return Type
- WorkflowReadResponse|error - Returned if the request is successful
get api/'3/workflows/capabilities
Isolated FunctionResource Function
function get api/'3/workflows/capabilities(map<string|string[]> headers, *WorkflowCapabilitiesQueries queries) returns WorkflowCapabilities|errorGet available workflow capabilities
Parameters
- queries *WorkflowCapabilitiesQueries - Queries to be sent with the request
Return Type
- WorkflowCapabilities|error - Returned if the request is successful
post api/'3/workflows/create
Isolated FunctionResource Function
function post api/'3/workflows/create(WorkflowCreateRequest payload, map<string|string[]> headers) returns WorkflowCreateResponse|errorBulk create workflows
Parameters
- payload WorkflowCreateRequest -
Return Type
- WorkflowCreateResponse|error - Returned if the request is successful
post api/'3/workflows/create/validation
Isolated FunctionResource Function
function post api/'3/workflows/create/validation(WorkflowCreateValidateRequest payload, map<string|string[]> headers) returns WorkflowValidationErrorList|errorValidate create workflows
Parameters
- payload WorkflowCreateValidateRequest -
Return Type
- WorkflowValidationErrorList|error - Returned if the request is successful
get api/'3/workflows/defaultEditor
Isolated FunctionResource Function
function get api/'3/workflows/defaultEditor(map<string|string[]> headers) returns DefaultWorkflowEditorResponse|errorGet the user's default workflow editor
Return Type
- DefaultWorkflowEditorResponse|error - Returned if the request is successful
get api/'3/workflows/search
Isolated FunctionResource Function
function get api/'3/workflows/search(map<string|string[]> headers, *SearchWorkflowsQueries queries) returns WorkflowSearchResponse|errorSearch workflows
Parameters
- queries *SearchWorkflowsQueries - Queries to be sent with the request
Return Type
- WorkflowSearchResponse|error - Returned if the request is successful
post api/'3/workflows/update
Isolated FunctionResource Function
function post api/'3/workflows/update(WorkflowUpdateRequest payload, map<string|string[]> headers, *UpdateWorkflowsQueries queries) returns WorkflowUpdateResponse|errorBulk update workflows
Parameters
- payload WorkflowUpdateRequest -
- queries *UpdateWorkflowsQueries - Queries to be sent with the request
Return Type
- WorkflowUpdateResponse|error - Returned if the request is successful
post api/'3/workflows/update/validation
Isolated FunctionResource Function
function post api/'3/workflows/update/validation(WorkflowUpdateValidateRequestBean payload, map<string|string[]> headers) returns WorkflowValidationErrorList|errorValidate update workflows
Parameters
- payload WorkflowUpdateValidateRequestBean -
Return Type
- WorkflowValidationErrorList|error - Returned if the request is successful
get api/'3/workflowscheme
Isolated FunctionResource Function
function get api/'3/workflowscheme(map<string|string[]> headers, *GetAllWorkflowSchemesQueries queries) returns PageBeanWorkflowScheme|errorGet all workflow schemes
Parameters
- queries *GetAllWorkflowSchemesQueries - Queries to be sent with the request
Return Type
- PageBeanWorkflowScheme|error - Returned if the request is successful
post api/'3/workflowscheme
Isolated FunctionResource Function
function post api/'3/workflowscheme(WorkflowScheme payload, map<string|string[]> headers) returns WorkflowScheme|errorCreate workflow scheme
Parameters
- payload WorkflowScheme -
Return Type
- WorkflowScheme|error - Returned if the request is successful
get api/'3/workflowscheme/project
Isolated FunctionResource Function
function get api/'3/workflowscheme/project(map<string|string[]> headers, *GetWorkflowSchemeProjectAssociationsQueries queries) returns ContainerOfWorkflowSchemeAssociations|errorGet workflow scheme project associations
Parameters
- queries *GetWorkflowSchemeProjectAssociationsQueries - Queries to be sent with the request
Return Type
- ContainerOfWorkflowSchemeAssociations|error - Returned if the request is successful
put api/'3/workflowscheme/project
Isolated FunctionResource Function
function put api/'3/workflowscheme/project(WorkflowSchemeProjectAssociation payload, map<string|string[]> headers) returns json|errorAssign workflow scheme to project
Parameters
- payload WorkflowSchemeProjectAssociation -
Return Type
- json|error - Returned if the request is successful
post api/'3/workflowscheme/read
Isolated FunctionResource Function
function post api/'3/workflowscheme/read(WorkflowSchemeReadRequest payload, map<string|string[]> headers, *ReadWorkflowSchemesQueries queries) returns WorkflowSchemeReadResponse[]|errorBulk get workflow schemes
Parameters
- payload WorkflowSchemeReadRequest -
- queries *ReadWorkflowSchemesQueries - Queries to be sent with the request
Return Type
- WorkflowSchemeReadResponse[]|error - Returned if the request is successful
post api/'3/workflowscheme/update
Isolated FunctionResource Function
function post api/'3/workflowscheme/update(WorkflowSchemeUpdateRequest payload, map<string|string[]> headers) returns json|errorUpdate workflow scheme
Parameters
- payload WorkflowSchemeUpdateRequest -
Return Type
- json|error - Returned if the request is successful and there is no asynchronous task
post api/'3/workflowscheme/update/mappings
Isolated FunctionResource Function
function post api/'3/workflowscheme/update/mappings(WorkflowSchemeUpdateRequiredMappingsRequest payload, map<string|string[]> headers) returns WorkflowSchemeUpdateRequiredMappingsResponse|errorGet required status mappings for workflow scheme update
Parameters
Return Type
- WorkflowSchemeUpdateRequiredMappingsResponse|error - Returned if the request is successful
get api/'3/workflowscheme/[int id]
Isolated FunctionResource Function
function get api/'3/workflowscheme/[int id](map<string|string[]> headers, *GetWorkflowSchemeQueries queries) returns WorkflowScheme|errorGet workflow scheme
Parameters
- queries *GetWorkflowSchemeQueries - Queries to be sent with the request
Return Type
- WorkflowScheme|error - Returned if the request is successful
put api/'3/workflowscheme/[int id]
Isolated FunctionResource Function
function put api/'3/workflowscheme/[int id](WorkflowScheme payload, map<string|string[]> headers) returns WorkflowScheme|errorClassic update workflow scheme
Parameters
- payload WorkflowScheme -
Return Type
- WorkflowScheme|error - Returned if the request is successful
delete api/'3/workflowscheme/[int id]
Isolated FunctionResource Function
Delete workflow scheme
Return Type
- json|error - Returned if the request is successful
post api/'3/workflowscheme/[int id]/createdraft
Isolated FunctionResource Function
function post api/'3/workflowscheme/[int id]/createdraft(map<string|string[]> headers) returns WorkflowScheme|errorCreate draft workflow scheme
Return Type
- WorkflowScheme|error - Returned if the request is successful
get api/'3/workflowscheme/[int id]/default
Isolated FunctionResource Function
function get api/'3/workflowscheme/[int id]/default(map<string|string[]> headers, *GetDefaultWorkflowQueries queries) returns DefaultWorkflow|errorGet default workflow
Parameters
- queries *GetDefaultWorkflowQueries - Queries to be sent with the request
Return Type
- DefaultWorkflow|error - Returned if the request is successful
put api/'3/workflowscheme/[int id]/default
Isolated FunctionResource Function
function put api/'3/workflowscheme/[int id]/default(DefaultWorkflow payload, map<string|string[]> headers) returns WorkflowScheme|errorUpdate default workflow
Parameters
- payload DefaultWorkflow - The new default workflow
Return Type
- WorkflowScheme|error - Returned if the request is successful
delete api/'3/workflowscheme/[int id]/default
Isolated FunctionResource Function
function delete api/'3/workflowscheme/[int id]/default(map<string|string[]> headers, *DeleteDefaultWorkflowQueries queries) returns WorkflowScheme|errorDelete default workflow
Parameters
- queries *DeleteDefaultWorkflowQueries - Queries to be sent with the request
Return Type
- WorkflowScheme|error - Returned if the request is successful
get api/'3/workflowscheme/[int id]/draft
Isolated FunctionResource Function
function get api/'3/workflowscheme/[int id]/draft(map<string|string[]> headers) returns WorkflowScheme|errorGet draft workflow scheme
Return Type
- WorkflowScheme|error - Returned if the request is successful
put api/'3/workflowscheme/[int id]/draft
Isolated FunctionResource Function
function put api/'3/workflowscheme/[int id]/draft(WorkflowScheme payload, map<string|string[]> headers) returns WorkflowScheme|errorUpdate draft workflow scheme
Parameters
- payload WorkflowScheme -
Return Type
- WorkflowScheme|error - Returned if the request is successful
delete api/'3/workflowscheme/[int id]/draft
Isolated FunctionResource Function
Delete draft workflow scheme
Return Type
- error? - Returned if the request is successful
get api/'3/workflowscheme/[int id]/draft/default
Isolated FunctionResource Function
function get api/'3/workflowscheme/[int id]/draft/default(map<string|string[]> headers) returns DefaultWorkflow|errorGet draft default workflow
Return Type
- DefaultWorkflow|error - Returned if the request is successful
put api/'3/workflowscheme/[int id]/draft/default
Isolated FunctionResource Function
function put api/'3/workflowscheme/[int id]/draft/default(DefaultWorkflow payload, map<string|string[]> headers) returns WorkflowScheme|errorUpdate draft default workflow
Parameters
- payload DefaultWorkflow - The object for the new default workflow
Return Type
- WorkflowScheme|error - Returned if the request is successful
delete api/'3/workflowscheme/[int id]/draft/default
Isolated FunctionResource Function
function delete api/'3/workflowscheme/[int id]/draft/default(map<string|string[]> headers) returns WorkflowScheme|errorDelete draft default workflow
Return Type
- WorkflowScheme|error - Returned if the request is successful
get api/'3/workflowscheme/[int id]/draft/issuetype/[string issueType]
Isolated FunctionResource Function
function get api/'3/workflowscheme/[int id]/draft/issuetype/[string issueType](map<string|string[]> headers) returns IssueTypeWorkflowMapping|errorGet workflow for issue type in draft workflow scheme
Return Type
- IssueTypeWorkflowMapping|error - Returned if the request is successful
put api/'3/workflowscheme/[int id]/draft/issuetype/[string issueType]
Isolated FunctionResource Function
function put api/'3/workflowscheme/[int id]/draft/issuetype/[string issueType](IssueTypeWorkflowMapping payload, map<string|string[]> headers) returns WorkflowScheme|errorSet workflow for issue type in draft workflow scheme
Parameters
- payload IssueTypeWorkflowMapping - The issue type-project mapping
Return Type
- WorkflowScheme|error - Returned if the request is successful
delete api/'3/workflowscheme/[int id]/draft/issuetype/[string issueType]
Isolated FunctionResource Function
function delete api/'3/workflowscheme/[int id]/draft/issuetype/[string issueType](map<string|string[]> headers) returns WorkflowScheme|errorDelete workflow for issue type in draft workflow scheme
Return Type
- WorkflowScheme|error - Returned if the request is successful
post api/'3/workflowscheme/[int id]/draft/publish
Isolated FunctionResource Function
function post api/'3/workflowscheme/[int id]/draft/publish(PublishDraftWorkflowScheme payload, map<string|string[]> headers, *PublishDraftWorkflowSchemeQueries queries) returns error?Publish draft workflow scheme
Parameters
- payload PublishDraftWorkflowScheme - Details of the status mappings
- queries *PublishDraftWorkflowSchemeQueries - Queries to be sent with the request
Return Type
- error? - Returned if the request is only for validation and is successful
get api/'3/workflowscheme/[int id]/draft/workflow
Isolated FunctionResource Function
function get api/'3/workflowscheme/[int id]/draft/workflow(map<string|string[]> headers, *GetDraftWorkflowQueries queries) returns IssueTypesWorkflowMapping|errorGet issue types for workflows in draft workflow scheme
Parameters
- queries *GetDraftWorkflowQueries - Queries to be sent with the request
Return Type
- IssueTypesWorkflowMapping|error - Returned if the request is successful
put api/'3/workflowscheme/[int id]/draft/workflow
Isolated FunctionResource Function
function put api/'3/workflowscheme/[int id]/draft/workflow(IssueTypesWorkflowMapping payload, map<string|string[]> headers, *UpdateDraftWorkflowMappingQueries queries) returns WorkflowScheme|errorSet issue types for workflow in workflow scheme
Parameters
- payload IssueTypesWorkflowMapping -
- queries *UpdateDraftWorkflowMappingQueries - Queries to be sent with the request
Return Type
- WorkflowScheme|error - Returned if the request is successful
delete api/'3/workflowscheme/[int id]/draft/workflow
Isolated FunctionResource Function
function delete api/'3/workflowscheme/[int id]/draft/workflow(map<string|string[]> headers, *DeleteDraftWorkflowMappingQueries queries) returns error?Delete issue types for workflow in draft workflow scheme
Parameters
- queries *DeleteDraftWorkflowMappingQueries - Queries to be sent with the request
Return Type
- error? - Returned if the request is successful
get api/'3/workflowscheme/[int id]/issuetype/[string issueType]
Isolated FunctionResource Function
function get api/'3/workflowscheme/[int id]/issuetype/[string issueType](map<string|string[]> headers, *GetWorkflowSchemeIssueTypeQueries queries) returns IssueTypeWorkflowMapping|errorGet workflow for issue type in workflow scheme
Parameters
- queries *GetWorkflowSchemeIssueTypeQueries - Queries to be sent with the request
Return Type
- IssueTypeWorkflowMapping|error - Returned if the request is successful
put api/'3/workflowscheme/[int id]/issuetype/[string issueType]
Isolated FunctionResource Function
function put api/'3/workflowscheme/[int id]/issuetype/[string issueType](IssueTypeWorkflowMapping payload, map<string|string[]> headers) returns WorkflowScheme|errorSet workflow for issue type in workflow scheme
Parameters
- payload IssueTypeWorkflowMapping - The issue type-project mapping
Return Type
- WorkflowScheme|error - Returned if the request is successful
delete api/'3/workflowscheme/[int id]/issuetype/[string issueType]
Isolated FunctionResource Function
function delete api/'3/workflowscheme/[int id]/issuetype/[string issueType](map<string|string[]> headers, *DeleteWorkflowSchemeIssueTypeQueries queries) returns WorkflowScheme|errorDelete workflow for issue type in workflow scheme
Parameters
- queries *DeleteWorkflowSchemeIssueTypeQueries - Queries to be sent with the request
Return Type
- WorkflowScheme|error - Returned if the request is successful
get api/'3/workflowscheme/[int id]/workflow
Isolated FunctionResource Function
function get api/'3/workflowscheme/[int id]/workflow(map<string|string[]> headers, *GetWorkflowQueries queries) returns IssueTypesWorkflowMapping|errorGet issue types for workflows in workflow scheme
Parameters
- queries *GetWorkflowQueries - Queries to be sent with the request
Return Type
- IssueTypesWorkflowMapping|error - Returned if the request is successful
put api/'3/workflowscheme/[int id]/workflow
Isolated FunctionResource Function
function put api/'3/workflowscheme/[int id]/workflow(IssueTypesWorkflowMapping payload, map<string|string[]> headers, *UpdateWorkflowMappingQueries queries) returns WorkflowScheme|errorSet issue types for workflow in workflow scheme
Parameters
- payload IssueTypesWorkflowMapping -
- queries *UpdateWorkflowMappingQueries - Queries to be sent with the request
Return Type
- WorkflowScheme|error - Returned if the request is successful
delete api/'3/workflowscheme/[int id]/workflow
Isolated FunctionResource Function
function delete api/'3/workflowscheme/[int id]/workflow(map<string|string[]> headers, *DeleteWorkflowMappingQueries queries) returns error?Delete issue types for workflow in workflow scheme
Parameters
- queries *DeleteWorkflowMappingQueries - Queries to be sent with the request
Return Type
- error? - Returned if the request is successful
get api/'3/workflowscheme/[string workflowSchemeId]/projectUsages
Isolated FunctionResource Function
function get api/'3/workflowscheme/[string workflowSchemeId]/projectUsages(map<string|string[]> headers, *GetProjectUsagesForWorkflowSchemeQueries queries) returns WorkflowSchemeProjectUsageDTO|errorGet projects which are using a given workflow scheme
Parameters
- queries *GetProjectUsagesForWorkflowSchemeQueries - Queries to be sent with the request
Return Type
- WorkflowSchemeProjectUsageDTO|error - Returned if the request is successful
get api/'3/worklog/deleted
Isolated FunctionResource Function
function get api/'3/worklog/deleted(map<string|string[]> headers, *GetIdsOfWorklogsDeletedSinceQueries queries) returns ChangedWorklogs|errorGet IDs of deleted worklogs
Parameters
- queries *GetIdsOfWorklogsDeletedSinceQueries - Queries to be sent with the request
Return Type
- ChangedWorklogs|error - Returned if the request is successful
post api/'3/worklog/list
Isolated FunctionResource Function
function post api/'3/worklog/list(WorklogIdsRequestBean payload, map<string|string[]> headers, *GetWorklogsForIdsQueries queries) returns Worklog[]|errorGet worklogs
Parameters
- payload WorklogIdsRequestBean - A JSON object containing a list of worklog IDs
- queries *GetWorklogsForIdsQueries - Queries to be sent with the request
get api/'3/worklog/updated
Isolated FunctionResource Function
function get api/'3/worklog/updated(map<string|string[]> headers, *GetIdsOfWorklogsModifiedSinceQueries queries) returns ChangedWorklogs|errorGet IDs of updated worklogs
Parameters
- queries *GetIdsOfWorklogsModifiedSinceQueries - Queries to be sent with the request
Return Type
- ChangedWorklogs|error - Returned if the request is successful
get atlassian-connect/'1/addons/[string addonKey]/properties
Isolated FunctionResource Function
function get atlassian\-connect/'1/addons/[string addonKey]/properties(map<string|string[]> headers) returns PropertyKeys|errorGet app properties
Return Type
- PropertyKeys|error - Returned if the request is successful
get atlassian-connect/'1/addons/[string addonKey]/properties/[string propertyKey]
Isolated FunctionResource Function
function get atlassian\-connect/'1/addons/[string addonKey]/properties/[string propertyKey](map<string|string[]> headers) returns EntityProperty|errorGet app property
Return Type
- EntityProperty|error - Returned if the request is successful
put atlassian-connect/'1/addons/[string addonKey]/properties/[string propertyKey]
Isolated FunctionResource Function
function put atlassian\-connect/'1/addons/[string addonKey]/properties/[string propertyKey](json payload, map<string|string[]> headers) returns OperationMessage|errorSet app property
Parameters
- payload json -
Return Type
- OperationMessage|error - Returned if the property is updated
delete atlassian-connect/'1/addons/[string addonKey]/properties/[string propertyKey]
Isolated FunctionResource Function
function delete atlassian\-connect/'1/addons/[string addonKey]/properties/[string propertyKey](map<string|string[]> headers) returns error?Delete app property
Return Type
- error? - Returned if the request is successful
get atlassian-connect/'1/app/module/dynamic
Isolated FunctionResource Function
function get atlassian\-connect/'1/app/module/dynamic(map<string|string[]> headers) returns ConnectModules|errorGet modules
Return Type
- ConnectModules|error - Returned if the request is successful
post atlassian-connect/'1/app/module/dynamic
Isolated FunctionResource Function
function post atlassian\-connect/'1/app/module/dynamic(ConnectModules payload, map<string|string[]> headers) returns error?Register modules
Parameters
- payload ConnectModules -
Return Type
- error? - Returned if the request is successful
delete atlassian-connect/'1/app/module/dynamic
Isolated FunctionResource Function
function delete atlassian\-connect/'1/app/module/dynamic(map<string|string[]> headers, *DynamicModulesResourceRemoveModulesDeleteQueries queries) returns error?Remove modules
Parameters
- queries *DynamicModulesResourceRemoveModulesDeleteQueries - Queries to be sent with the request
Return Type
- error? - Returned if the request is successful
put atlassian-connect/'1/migration/'field
Isolated FunctionResource Function
function put atlassian\-connect/'1/migration/'field(AppIssueFieldValueUpdateResourceUpdateIssueFieldsPutHeaders headers, ConnectCustomFieldValues payload) returns json|errorBulk update custom field value
Parameters
- headers AppIssueFieldValueUpdateResourceUpdateIssueFieldsPutHeaders - Headers to be sent with the request
- payload ConnectCustomFieldValues -
Return Type
- json|error - Returned if the request is successful
put atlassian-connect/'1/migration/properties/["IssueProperty"|"CommentProperty"|"DashboardItemProperty"|"IssueTypeProperty"|"ProjectProperty"|"UserProperty"|"WorklogProperty"|"BoardProperty"|"SprintProperty" entityType]
Isolated FunctionResource Function
function put atlassian\-connect/'1/migration/properties/["IssueProperty"|"CommentProperty"|"DashboardItemProperty"|"IssueTypeProperty"|"ProjectProperty"|"UserProperty"|"WorklogProperty"|"BoardProperty"|"SprintProperty" entityType](MigrationResourceUpdateEntityPropertiesValuePutHeaders headers, EntityPropertyDetails[] payload) returns error?Bulk update entity properties
Parameters
- headers MigrationResourceUpdateEntityPropertiesValuePutHeaders - Headers to be sent with the request
- payload EntityPropertyDetails[] -
Return Type
- error? - Returned if the request is successful
post atlassian-connect/'1/migration/workflow/rule/search
Isolated FunctionResource Function
function post atlassian\-connect/'1/migration/workflow/rule/search(MigrationResourceWorkflowRuleSearchPostHeaders headers, WorkflowRulesSearch payload) returns WorkflowRulesSearchDetails|errorGet workflow transition rule configurations
Parameters
- headers MigrationResourceWorkflowRuleSearchPostHeaders - Headers to be sent with the request
- payload WorkflowRulesSearch -
Return Type
- WorkflowRulesSearchDetails|error - Returned if the request is successful
get atlassian-connect/'1/service-registry
Isolated FunctionResource Function
function get atlassian\-connect/'1/service\-registry(map<string|string[]> headers, *ServiceRegistryResourceServicesGetQueries queries) returns ServiceRegistry[]|errorRetrieve the attributes of service registries
Parameters
- queries *ServiceRegistryResourceServicesGetQueries - Queries to be sent with the request
Return Type
- ServiceRegistry[]|error - Returned if the request is successful
put forge/'1/app/properties/[string propertyKey]
Isolated FunctionResource Function
function put forge/'1/app/properties/[string propertyKey](json payload, map<string|string[]> headers) returns OperationMessage|errorSet app property (Forge)
Parameters
- payload json -
Return Type
- OperationMessage|error - Returned if the property is updated
delete forge/'1/app/properties/[string propertyKey]
Isolated FunctionResource Function
function delete forge/'1/app/properties/[string propertyKey](map<string|string[]> headers) returns error?Delete app property (Forge)
Return Type
- error? - Returned if the request is successful
Records
jira: ActorInputBean
Closed record
Fields
- groupId? string[] - The ID of the group to add as a default actor. This parameter cannot be used with the
groupparameter This parameter accepts a comma-separated list. For example,"groupId":["77f6ab39-e755-4570-a6ae-2d7a8df0bcb8", "0c011f85-69ed-49c4-a801-3b18d0f771bc"]
- 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 cannot be used with the
groupIdparameter. As a group's name can change,use ofgroupIdis recommended. This parameter accepts a comma-separated list. For example,"group":["project-admin", "jira-developers"]
jira: ActorsMap
Closed record
Fields
- groupId? string[] - The ID of the group to add. This parameter cannot be used with the
groupparameter
- user? string[] - The user account ID of the user to add
- group? string[] - The name of the group to add. This parameter cannot be used with the
groupIdparameter. As a group's name can change, use ofgroupIdis recommended
jira: AddAtlassianTeamRequest
Closed record
Fields
- planningStyle "Scrum"|"Kanban" - The planning style for the Atlassian team. This must be "Scrum" or "Kanban"
- issueSourceId? int - The ID of the issue source for the Atlassian team
- sprintLength? int - The sprint length for the Atlassian team
- id string - The Atlassian team ID
- capacity? decimal - The capacity for the Atlassian team
jira: AddCommentQueries
Represents the Queries record for the operation: addComment
Fields
jira: AddFieldBean
Closed record
Fields
- fieldId string - The ID of the field to add
jira: AddGroupBean
Fields
- name string - The name of the group.
jira: AddNotificationsDetails
Details of notifications which should be added to the notification scheme
Fields
- notificationSchemeEvents NotificationSchemeEventDetails[] - The list of notifications which should be added to the notification scheme.
jira: AddSecuritySchemeLevelsRequestBean
Closed record
Fields
- levels? SecuritySchemeLevelBean[] - The list of scheme levels which should be added to the security scheme
jira: AddUserToGroupQueries
Represents the Queries record for the operation: addUserToGroup
Fields
- groupId? string - The ID of the group. This parameter cannot be used with the
groupNameparameter
- groupname? string - As a group's name can change, use of
groupIdis recommended to identify a group.
The name of the group. This parameter cannot be used with thegroupIdparameter
jira: AddWorklogQueries
Represents the Queries record for the operation: addWorklog
Fields
- newEstimate? string - 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
adjustEstimateisnew
- adjustEstimate "new"|"leave"|"manual"|"auto" (default "auto") - Defines how to update the issue's time estimate, the options are:
newSets the estimate to a specific value, defined innewEstimate.leaveLeaves the estimate unchanged.manualReduces the estimate by amount specified inreduceBy.autoReduces the estimate by the value oftimeSpentin the worklog
- reduceBy? string - The amount to reduce the issue's remaining estimate by, as days (#d), hours (#h), or minutes (#m). For example, 2d. Required when
adjustEstimateismanual
- 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. Connect and Forge app users with Administer Jira global permission can use this flag
- notifyUsers boolean(default true) - Whether users watching the issue are notified by email
jira: AnalyseExpressionQueries
Represents the Queries record for the operation: analyseExpression
Fields
- 'check "syntax"|"type"|"complexity" (default "syntax") - The check to perform:
syntaxEach expression's syntax is checked to ensure the expression can be parsed. Also, syntactic limits are validated. For example, the expression's length.typeEXPERIMENTAL. Each expression is type checked and the final type of the expression inferred. Any type errors that would result in the expression failure at runtime are reported. For example, accessing properties that don't exist or passing the wrong number of arguments to functions. Also performs the syntax check.complexityEXPERIMENTAL. Determines the formulae for how many expensive operations each expression may execute
jira: AnnouncementBannerConfiguration
Closed record
Announcement banner configuration
Fields
- visibility? "PUBLIC"|"PRIVATE" - Visibility of the announcement banner
- isEnabled? boolean - Flag indicating if the announcement banner is enabled or not
- isDismissible? boolean - Flag indicating if the announcement banner can be dismissed by the user
- message? string - The text on the announcement banner
- hashId? string - Hash of the banner data. The client detects updates by comparing hash IDs
jira: AnnouncementBannerConfigurationUpdate
Closed record
Configuration of the announcement banner
Fields
- visibility? string - Visibility of the announcement banner. Can be public or private
- isEnabled? boolean - Flag indicating if the announcement banner is enabled or not
- isDismissible? boolean - Flag indicating if the announcement banner can be dismissed by the user
- message? string - The text on the announcement banner
jira: AppIssueFieldValueUpdateResourceUpdateIssueFieldsPutHeaders
Represents the Headers record for the operation: AppIssueFieldValueUpdateResource.updateIssueFields_put
Fields
- atlassianTransferId string - The ID of the transfer
jira: Application
The application the linked item is in
Fields
- 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.
- 'type? string - The name-spaced type of the application, used by registered rendering apps.
jira: ApplicationProperty
Closed record
Details of an application property
Fields
- allowedValues? string[] - The allowed values, if applicable
- defaultValue? string - The default value of the application property
- name? string - The name of the application property
- id? string - The ID of the application property. The ID and key are the same
- 'type? string - The data type of the application property
- value? string - The new value
- 'key? string - The key of the application property. The ID and key are the same
- desc? string - The description of the application property
- example? string -
jira: ApplicationRole
Closed record
Details of an application role
Fields
- defaultGroups? string[] - The groups that are granted default access for this application role. As a group's name can change, use of
defaultGroupsDetailsis recommended to identify a groups
- groupDetails? GroupName[] - The groups associated with the application role
- hasUnlimitedSeats? boolean -
- groups? string[] - The groups associated with the application role. As a group's name can change, use of
groupDetailsis recommended to identify a groups
- remainingSeats? Signed32 - The count of users remaining on your license
- platform? boolean - Indicates if the application role belongs to Jira platform (
jira-core)
- selectedByDefault? boolean - Determines whether this application role should be selected by default on user creation
- numberOfSeats? Signed32 - The maximum count of users on your license
- defaultGroupsDetails? GroupName[] - The groups that are granted default access for this application role
- userCount? Signed32 - The number of users counting against your license
- userCountDescription? string - The type of users being counted against your license
- name? string - The display name of the application role
- defined? boolean - Deprecated
- 'key? string - The key of the application role
jira: ApprovalConfiguration
Closed record
The approval configuration of a status within a workflow. Applies only to Jira Service Management approvals
Fields
- active "true"|"false" - Whether the approval configuration is active
- conditionValue string - The number or percentage of approvals required for a request to be approved. If
conditionTypeisnumber, the value must be 20 or less. IfconditionTypeispercent, the value must be 100 or less
- conditionType "number"|"percent"|"numberPerPrincipal" - How the required approval count is calculated. It may be configured to require a specific number of approvals, or approval by a percentage of approvers. If the approvers source field is Approver groups, you can configure how many approvals per group are required for the request to be approved. The number will be the same across all groups
- exclude? ("assignee"|"reporter"?)[]? - A list of roles that should be excluded as possible approvers
- transitionApproved string - The numeric ID of the transition to be executed if the request is approved
- fieldId string - The custom field ID of the "Approvers" or "Approver Groups" field
- prePopulatedFieldId? string? - The custom field ID of the field used to pre-populate the Approver field. Only supports the "Affected Services" field
- transitionRejected string - The numeric ID of the transition to be executed if the request is declined
jira: AppWorkflowTransitionRule
Closed record
A workflow transition rule
Fields
- configuration RuleConfiguration - A rule configuration
- id string - The ID of the transition rule
- 'key string - The key of the rule, as defined in the Connect or the Forge app descriptor
- transition? WorkflowTransition -
jira: ArchivedIssuesFilterRequest
Details of a filter for exporting archived issues
Fields
- archivedBy? string[] - List archived issues archived by a specified account ID.
- archivedDateRange? DateRangeFilterRequest - List issues archived within a specified date range
- issueTypes? string[] - List archived issues with a specified issue type ID.
- projects? string[] - List archived issues with a specified project key.
- reporters? string[] - List archived issues where the reporter is a specified account ID.
jira: ArchiveIssueAsyncRequest
Closed record
Fields
- jql? string -
jira: AssignPermissionSchemeQueries
Represents the Queries record for the operation: assignPermissionScheme
Fields
- expand? string - 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:
allReturns all expandable information.fieldReturns information about the custom field granted the permission.groupReturns information about the group that is granted the permission.permissionsReturns all permission grants for each permission scheme.projectRoleReturns information about the project role granted the permission.userReturns information about the user who is granted the permission
jira: AssociatedItemBean
Closed record
Details of an item associated with the changed record
Fields
- parentName? string - The name of the associated parent record
- name? string - The name of the associated record
- typeName? string - The type of the associated record
- id? string - The ID of the associated record
- parentId? string - The ID of the associated parent record
jira: AssociateFieldConfigurationsWithIssueTypesRequest
Closed record
Details of a field configuration to issue type mappings
Fields
- mappings FieldConfigurationToIssueTypeMapping[] - Field configuration to issue type mappings
jira: AssociateSecuritySchemeWithProjectDetails
Closed record
Issue security scheme, project, and remapping details
Fields
- oldToNewSecurityLevelMappings? OldToNewSecurityLevelMappingsBean[] - The list of scheme levels which should be remapped to new levels of the issue security scheme
- schemeId string - The ID of the issue security scheme. Providing null will clear the association with the issue security scheme
- projectId string - The ID of the project
jira: AssociationContextObject
Closed record
Field association for example PROJECT_ID
Fields
- identifier? record {} -
- 'type string -
jira: Attachment
Details about an attachment
Fields
- content? string - The content of the attachment.
- created? string - The datetime the attachment was created.
- filename? string - The file name of the attachment.
- id? string - The ID of the attachment.
- mimeType? string - The MIME type of the attachment.
- self? string - The URL of the attachment details response.
- size? int - The size of the attachment.
- thumbnail? string - The URL of a thumbnail representing the attachment.
jira: AttachmentArchiveEntry
Closed record
Fields
- entryIndex? int -
- size? int -
- name? string -
- mediaType? string -
- abbreviatedName? string -
jira: AttachmentArchiveImpl
Closed record
Fields
- totalEntryCount? Signed32 - The number of items in the archive
- entries? AttachmentArchiveEntry[] - The list of the items included in the archive
jira: AttachmentArchiveItemReadable
Closed record
Metadata for an item in an attachment archive
Fields
- path? string - The path of the archive item
- size? string - The size of the archive item
- index? int - The position of the item within the archive
- mediaType? string - The MIME type of the archive item
- label? string - The label for the archive item
jira: AttachmentArchiveMetadataReadable
Closed record
Metadata for an archive (for example a zip) and its contents
Fields
- totalEntryCount? int - The number of items included in the archive
- entries? AttachmentArchiveItemReadable[] - The list of the items included in the archive
- name? string - The name of the archive file
- mediaType? string - The MIME type of the attachment
- id? int - The ID of the attachment
jira: AttachmentMetadata
Closed record
Metadata for an issue attachment
Fields
- thumbnail? string - The URL of a thumbnail representing the attachment
- filename? string - The name of the attachment file
- size? int - The size of the attachment
- created? string - The datetime the attachment was created
- self? string - The URL of the attachment metadata details
- id? int - The ID of the attachment
- mimeType? string - The MIME type of the attachment
- content? string - The URL of the attachment
- properties? record {} - Additional properties of the attachment
jira: AttachmentSettings
Closed record
Details of the instance's attachment settings
Fields
- uploadLimit? int - The maximum size of attachments permitted, in bytes
- enabled? boolean - Whether the ability to add attachments is enabled
jira: AuditRecordBean
Closed record
An audit record
Fields
- changedValues? ChangedValueBean[] - The list of values changed in the record event
- summary? string - The summary of the audit record
- objectItem? AssociatedItemBean - Details of an item associated with the changed record
- created? string - The date and time on which the audit record was created
- eventSource? string - The event the audit record originated from
- associatedItems? AssociatedItemBean[] - The list of items associated with the changed record
- description? string - The description of the audit record
- id? int - The ID of the audit record
- category? string - The category of the audit record. For a list of these categories, see the help article Auditing in Jira applications
- remoteAddress? string - The URL of the computer where the creation of the audit record was initiated
jira: AuditRecords
Closed record
Container for a list of audit records
Fields
- total? int - The total number of audit items returned
- offset? Signed32 - The number of audit items skipped before the first item in this list
- records? AuditRecordBean[] - The list of audit items
- 'limit? Signed32 - The requested or default limit on the number of audit items to be returned
jira: AutoCompleteSuggestion
Closed record
A field auto-complete suggestion
Fields
- displayName? string - The display name of a suggested item. If
fieldValueorpredicateValueare provided, the matching text is highlighted with the HTML bold tag
- value? string - The value of a suggested item
jira: AutoCompleteSuggestions
Closed record
The results from a JQL query
Fields
- results? AutoCompleteSuggestion[] - The list of suggested item
jira: AvailableDashboardGadget
Closed record
The details of the available dashboard gadget
Fields
- title string - The title of the gadget
- uri? string - The URI of the gadget type
- moduleKey? string - The module key of the gadget type
jira: AvailableDashboardGadgetsResponse
Closed record
The list of available gadgets
Fields
- gadgets AvailableDashboardGadget[] - The list of available gadgets
jira: AvailableWorkflowConnectRule
Closed record
The Connect provided ecosystem rules available
Fields
- editUrl? string - The URL edit path segment defined in the Connect module
- ruleType? "Condition"|"Validator"|"Function"|"Screen" - The rule type
- name? string - The rule name
- viewUrl? string - The URL view path segment defined in the Connect module
- createUrl? string - The URL creation path segment defined in the Connect module
- description? string - The rule description
- addonKey? string - The add-on providing the rule
- ruleKey? string - The rule key
- moduleKey? string - The module providing the rule
jira: AvailableWorkflowForgeRule
Closed record
The Forge provided ecosystem rules available
Fields
- ruleType? "Condition"|"Validator"|"Function"|"Screen" - The rule type
- name? string - The rule name
- description? string - The rule description
- id? string - The unique ARI of the forge rule type
- ruleKey? string - The rule key
jira: AvailableWorkflowSystemRule
Closed record
The Atlassian provided system rules available
Fields
- isAvailableForInitialTransition boolean - Whether the rule can be added added to an initial transition
- ruleType "Condition"|"Validator"|"Function"|"Screen" - The rule type
- name string - The rule name
- description string - The rule description
- isVisible boolean - Whether the rule is visible
- ruleKey string - The rule key
- incompatibleRuleKeys string[] - List of rules that conflict with this one
jira: AvailableWorkflowTriggers
Closed record
The trigger rules available
Fields
- availableTypes AvailableWorkflowTriggerTypes[] - The list of available trigger types
- ruleKey string - The rule key of the rule
jira: AvailableWorkflowTriggerTypes
Closed record
The list of available trigger types
Fields
- name? string - The name of the trigger rule
- description? string - The description of the trigger rule
- 'type? string - The type identifier of trigger rule
jira: Avatar
Details of an avatar
Fields
- fileName? string - The file name of the avatar icon. Returned for system avatars.
- id string - The ID of the avatar.
- isDeletable? boolean - Whether the avatar can be deleted.
- isSelected? boolean - Whether the avatar is used in Jira. For example, shown as a project's avatar.
- isSystemAvatar? boolean - Whether the avatar is a system 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.
- urls? record { string... } - The list of avatar icon URLs.
jira: Avatars
Closed record
Details about system and custom avatars
Fields
- system? Avatar[] - System avatars list
- custom? Avatar[] - Custom avatars list
jira: AvatarUrlsBean
Closed record
Fields
- '48x48? string - The URL of the item's 48x48 pixel avatar
- '24x24? string - The URL of the item's 24x24 pixel avatar
- '16x16? string - The URL of the item's 16x16 pixel avatar
- '32x32? string - The URL of the item's 32x32 pixel avatar
jira: BoardColumnPayload
Closed record
The payload for creating a board column
Fields
- maximumIssueConstraint? int - The maximum issue constraint for the column
- name? string - The name of the column
- statusIds? ProjectCreateResourceIdentifier[] - The status IDs for the column
- minimumIssueConstraint? int - The minimum issue constraint for the column
jira: BoardFeaturePayload
Closed record
The payload for setting a board feature
Fields
- state? true|false - Whether the feature should be turned on or off
- featureKey? "ESTIMATION"|"SPRINTS" - The key of the feature
jira: BoardPayload
Closed record
The payload for creating a board
Fields
- boardFilterJQL? string - Takes in a JQL string to create a new filter. If no value is provided, it'll default to a JQL filter for the project creating
- cardColorStrategy? "ISSUE_TYPE"|"REQUEST_TYPE"|"ASSIGNEE"|"PRIORITY"|"NONE"|"CUSTOM" - Card color settings of the board
- features? BoardFeaturePayload[] - Feature settings for the board
- cardLayout? CardLayout - Card layout configuration
- quickFilters? QuickFilterPayload[] - The quick filters for the board
- columns? BoardColumnPayload[] - The columns of the board
- name? string - The name of the board
- swimlanes? SwimlanesPayload - The payload for customising a swimlanes on a board
- cardLayouts? CardLayoutField[] - Card layout settings of the board
- supportsSprint boolean(default true) - Whether sprints are supported on the board
- pcri? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
- workingDaysConfig? WorkingDaysConfig - Working days configuration
jira: BoardsPayload
Closed record
Fields
- boards? BoardPayload[] - The boards to be associated with the project
jira: BulkChangelogRequestBean
Closed record
Request bean for bulk changelog retrieval
Fields
- maxResults Signed32(default 1000) - The maximum number of items to return per page
- nextPageToken? string - The cursor for pagination
- issueIdsOrKeys string[] - List of issue IDs/keys to fetch changelogs for
- fieldIds? string[] - List of field IDs to filter changelogs
jira: BulkChangelogResponseBean
Closed record
A page of changelogs which is designed to handle multiple issues
Fields
- nextPageToken? string - Continuation token to fetch the next page. If this result represents the last or the only page, this token will be null
- issueChangeLogs? IssueChangeLog[] - The list of issues changelogs
jira: BulkChangeOwnerDetails
Closed record
Details for changing owners of shareable entities
Fields
- autofixName boolean - Whether the name is fixed automatically if it's duplicated after changing owner
- newOwner string - The account id of the new owner
jira: BulkContextualConfiguration
Closed record
Details of the contextual configuration for a custom field
Fields
- fieldContextId string - The ID of the field context the configuration is associated with
- schema? anydata - The field value schema
- configuration? anydata - The field configuration
- customFieldId string - The ID of the custom field
- id string - The ID of the configuration
jira: BulkCustomFieldOptionCreateRequest
Closed record
Details of the options to create for a custom field
Fields
- options? CustomFieldOptionCreate[] - Details of options to create
jira: BulkCustomFieldOptionUpdateRequest
Closed record
Details of the options to update for a custom field
Fields
- options? CustomFieldOptionUpdate[] - Details of the options to update
jira: BulkDeleteWorklogsQueries
Represents the Queries record for the operation: bulkDeleteWorklogs
Fields
- adjustEstimate "leave"|"auto" (default "auto") - Defines how to update the issue's time estimate, the options are:
leaveLeaves the estimate unchanged.autoReduces the estimate by the aggregate value oftimeSpentacross all worklogs being deleted
- overrideEditableFlag boolean(default false) - Whether the work log entries should be removed 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. Connect and Forge app users with admin permission can use this flag
jira: BulkEditActionError
Closed record
Errors of bulk edit action
Fields
- errorMessages string[] - The error messages
- errors record { string... } - The errors
jira: BulkEditGetFields
Closed record
Bulk Edit Get Fields Response
Fields
- startingAfter? string - The start cursor for use in pagination
- endingBefore? string - The end cursor for use in pagination
- fields? IssueBulkEditField[] - List of all the fields
jira: BulkEditShareableEntityRequest
Closed record
Details of a request to bulk edit shareable entity
Fields
- changeOwnerDetails? BulkChangeOwnerDetails - The details of change owner action
- permissionDetails? PermissionDetails - The permission details to be changed
- extendAdminPermissions? boolean - Whether the actions are executed by users with Administer Jira global permission
- action "changeOwner"|"changePermission"|"addPermission"|"removePermission" - Allowed action for bulk edit shareable entity
- entityIds int[] - The id list of shareable entities to be changed
jira: BulkEditShareableEntityResponse
Closed record
Details of a request to bulk edit shareable entity
Fields
- entityErrors? record { BulkEditActionError... } - The mapping dashboard id to errors if any
- action "changeOwner"|"changePermission"|"addPermission"|"removePermission" - Allowed action for bulk edit shareable entity
jira: BulkFetchIssueRequestBean
Closed record
Fields
- expand? string[] - Use expand to include additional information about issues in the response. Note that, unlike the majority of instances where
expandis specified,expandis defined as a list of values. The expand options are:renderedFieldsReturns field values rendered in HTML format.namesReturns the display name of each field.schemaReturns the schema describing a field type.transitionsReturns all possible transitions for the issue.operationsReturns all possible operations for the issue.editmetaReturns information about how each field can be edited.changelogReturns a list of recent updates to an issue, sorted by date, starting from the most recent.versionedRepresentationsInstead offields, returnsversionedRepresentationsa JSON array containing each version of a field's value, with the highest numbered item representing the most recent version
- fieldsByKeys? boolean - Reference fields by their key (rather than ID). The default is
false
- issueIdsOrKeys string[] - An array of issue IDs or issue keys to fetch. You can mix issue IDs and keys in the same query
- 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:
*allReturns all fields.*navigableReturns navigable fields.- Any issue field, prefixed with a minus to exclude.
*navigable. Examples:summary,commentReturns the summary and comments fields only.-descriptionReturns all navigable (default) fields except description.*all,-commentReturns all fields except comments.
fieldsparameters 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
- properties? string[] - A list of issue property keys of issue properties to be included in the results. A maximum of 5 issue property keys can be specified
jira: BulkGetGroupsQueries
Represents the Queries record for the operation: bulkGetGroups
Fields
- accessType? string - The access level of a group. Valid values: 'site-admin', 'admin', 'user'
- groupName? string[] - The name of a group. To specify multiple names, pass multiple
groupNameparameters. For example,groupName=administrators&groupName=jira-software-users
- maxResults Signed32(default 50) - The maximum number of items to return per page
- groupId? string[] - The ID of a group. To specify multiple IDs, pass multiple
groupIdparameters. For example,groupId=5b10a2844c20165700ede21g&groupId=5b10ac8d82e05b22cc7d4ef5
- applicationKey? string - The application key of the product user groups to search for. Valid values: 'jira-servicedesk', 'jira-software', 'jira-product-discovery', 'jira-core'
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: BulkGetUsersMigrationQueries
Represents the Queries record for the operation: bulkGetUsersMigration
Fields
- maxResults Signed32(default 10) - The maximum number of items to return per page
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
- 'key? string[] - Key of a user. To specify multiple users, pass multiple copies of this parameter. For example,
key=fred&key=barney. Required ifusernameisn't provided. Cannot be provided ifusernameis present
- username? string[] - Username of a user. To specify multiple users, pass multiple copies of this parameter. For example,
username=fred&username=barney. Required ifkeyisn't provided. Cannot be provided ifkeyis present
jira: BulkGetUsersQueries
Represents the Queries record for the operation: bulkGetUsers
Fields
- accountId BulkGetUsersQueriesAccountIdItemsString[] - The account ID of a user. To specify multiple users, pass multiple
accountIdparameters. For example,accountId=5b10a2844c20165700ede21g&accountId=5b10ac8d82e05b22cc7d4ef5
- maxResults Signed32(default 10) - The maximum number of items to return per page
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
- 'key? string[] - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details
- username? string[] - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details
jira: BulkIssueIsWatching
Closed record
A container for the watch status of a list of issues
Fields
- issuesIsWatching? record { boolean... } - The map of issue ID to boolean watch status
jira: BulkIssuePropertyUpdateRequest
Closed record
Bulk issue property update request details
Fields
- filter? IssueFilterForBulkPropertySet - The bulk operation filter
- 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
issueanduser. Issues for which the expression returns a value whose JSON representation is longer than 32768 characters are ignored
- value? anydata - The value of the property. The value must be a valid, non-empty JSON blob. The maximum length is 32768 characters
jira: BulkIssueResults
Closed record
The list of requested issues & fields
Fields
- issueErrors? IssueError[] - When Jira can't return an issue enumerated in a request due to a retriable error or payload constraint, we'll return the respective issue ID with a corresponding error message. This list is empty when there are no errors Issues which aren't found or that the user doesn't have permission to view won't be returned in this list
- issues? IssueBean[] - The list of issues
jira: BulkMoveWorklogsQueries
Represents the Queries record for the operation: bulkMoveWorklogs
Fields
- adjustEstimate "leave"|"auto" (default "auto") - Defines how to update the issues' time estimate, the options are:
leaveLeaves the estimate unchanged.autoReduces the estimate by the aggregate value oftimeSpentacross all worklogs being moved in the source issue, and increases it in the destination issue
- overrideEditableFlag boolean(default false) - Whether the work log entry should be moved to and from the issues even if the issues are not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Connect and Forge app users with admin permission can use this flag
jira: BulkOperationErrorResult
Closed record
Fields
- elementErrors? ErrorCollection - Error messages from an operation
- failedElementNumber? Signed32 -
- status? Signed32 -
jira: BulkOperationProgress
Closed record
Fields
- submittedBy? 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,
displayNameprovides 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,
accountIdreturns 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
- User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case,
- invalidOrInaccessibleIssueCount? Signed32 - The number of issues that are either invalid or issues that the user doesn't have permission to view, regardless of the success or failure of the operation
- failedAccessibleIssues? record { string[]... } - Map of issue IDs for which the operation failed and that the user has permission to view, to their one or more reasons for failure. These reasons are open-ended text descriptions of the error and are not selected from a predefined list of standard reasons
- created? string - A timestamp of when the task was submitted
- totalIssueCount? Signed32 - The number of issues that the bulk operation was attempted on
- progressPercent? int - Progress of the task as a percentage
- started? string - A timestamp of when the task was started
- updated? string - A timestamp of when the task progress was last updated
- taskId? string - The ID of the task
- processedAccessibleIssues? int[] - List of issue IDs for which the operation was successful and that the user has permission to view
- status? "ENQUEUED"|"RUNNING"|"COMPLETE"|"FAILED"|"CANCEL_REQUESTED"|"CANCELLED"|"DEAD" - The status of the task
jira: BulkPermissionGrants
Closed record
Details of global and project permissions granted to the user
Fields
- globalPermissions string[] - List of permissions granted to the user
- projectPermissions BulkProjectPermissionGrants[] - List of project permissions and the projects and issues those permissions provide access to
jira: BulkPermissionsRequestBean
Closed record
Details of global permissions to look up and project permissions with associated projects and issues to look up
Fields
- accountId? string - The account ID of a user
- globalPermissions? string[] - Global permissions to look up
- projectPermissions? BulkProjectPermissions[] - Project permissions with associated projects and issues to look up
jira: BulkProjectPermissionGrants
Closed record
List of project permissions and the projects and issues those permissions grant access to
Fields
- projects int[] - IDs of the projects the user has the permission for
- permission string - A project permission,
- issues int[] - IDs of the issues the user has the permission for
jira: BulkProjectPermissions
Closed record
Details of project permissions and associated issues and projects to look up
Fields
- projects? int[] - List of project IDs
- permissions string[] - List of project permissions
- issues? int[] - List of issue IDs
jira: BulkRedactionRequest
Closed record
Fields
- redactions? SingleRedactionRequest[] -
jira: BulkRedactionResponse
Closed record
Fields
- results SingleRedactionResponse[] - Result for requested redactions
jira: BulkTransitionGetAvailableTransitions
Closed record
Bulk Transition Get Available Transitions Response
Fields
- startingAfter? string - The start cursor for use in pagination
- endingBefore? string - The end cursor for use in pagination
- availableTransitions? IssueBulkTransitionForWorkflow[] - List of available transitions for bulk transition operation for requested issues grouped by workflow
jira: BulkTransitionSubmitInput
Closed record
Fields
- selectedIssueIdsOrKeys string[] - List of all the issue IDs or keys that are to be bulk transitioned
- transitionId string - The ID of the transition that is to be performed on the issues
jira: CardLayout
Closed record
Card layout configuration
Fields
- showDaysInColumn true|false (default false) - Whether to show days in column
jira: CardLayoutField
Closed record
Card layout settings of the board
Fields
- mode? "PLAN"|"WORK" -
- id? int -
- position? Signed32 -
- fieldId? string -
jira: ChangeDetails
Closed record
A change item
Fields
- 'field? string - The name of the field changed
- 'from? string - The details of the original value
- toString? string - The details of the new value as a string
- fromString? string - The details of the original value as a string
- to? string - The details of the new value
- fieldtype? string - The type of the field changed
- fieldId? string - The ID of the field changed
jira: ChangedValueBean
Closed record
Details of names changed in the record event
Fields
- changedTo? string - The value of the field after the change
- fieldName? string - The name of the field changed
- changedFrom? string - The value of the field before the change
jira: ChangedWorklog
Closed record
Details of a changed worklog
Fields
- updatedTime? int - The datetime of the change
- worklogId? int - The ID of the worklog
- properties? EntityProperty[] - Details of properties associated with the change
jira: ChangedWorklogs
Closed record
List of changed worklogs
Fields
- lastPage? boolean -
- nextPage? string - The URL of the next list of changed worklogs
- values? ChangedWorklog[] - Changed worklog list
- self? string - The URL of this changed worklogs list
- until? int - The datetime of the last worklog item in the list
- since? int - The datetime of the first worklog item in the list
jira: ChangeFilterOwner
Closed record
The account ID of the new owner
Fields
- accountId string - The account ID of the new owner
jira: Changelog
Closed record
A log of changes made to issue fields. Changelogs related to workflow associations are currently being deprecated
Fields
- historyMetadata? HistoryMetadata - The history metadata associated with the changed
- created? string - The date on which the change took place
- id? string - The ID of the changelog
- items? ChangeDetails[] - The list of items changed
jira: ColumnItem
Closed record
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
- body? anydata - The comment text in Atlassian Document Format.
- created? string - The date and time at which the comment was created.
- id? string - The ID of the comment.
- jsdAuthorCanSeeRequest? boolean - Whether the comment was added from an email sent by a person who is not part of the issue. See Allow external emails to be added as comments on issuesfor information on setting up this feature.
- 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.
- renderedBody? string - The rendered version of the comment.
- self? string - The URL of the comment.
- updateAuthor? UserDetails - The ID of the user who updated the comment last.
- 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.
jira: ComponentIssuesCount
Closed record
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: ComponentJsonBean
Fields
- ari? string -
- description? string -
- id? string -
- metadata? record { string... } -
- name? string -
- self? string -
jira: ComponentWithIssueCount
Closed record
Details about a component with a count of the issues it contains
Fields
- description? string - The description for the component
- project? string - The key of the project to which the component is assigned
- issueCount? int - Count of issues for the component
- lead? User - The user details for the component's lead user
- isAssigneeTypeValid? boolean - Whether a user is associated with
assigneeType. For example, if theassigneeTypeis set toCOMPONENT_LEADbut the component lead is not set, thenfalseis returned
- realAssigneeType? "PROJECT_DEFAULT"|"COMPONENT_LEAD"|"PROJECT_LEAD"|"UNASSIGNED" - 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,assigneeTypeis set toCOMPONENT_LEADbut no component lead is set. This property is set to one of the following values:PROJECT_LEADwhenassigneeTypeisPROJECT_LEADand the project lead has permission to be assigned issues in the project that the component is in.COMPONENT_LEADwhenassigneeType isCOMPONENT_LEADand the component lead has permission to be assigned issues in the project that the component is in.UNASSIGNEDwhenassigneeTypeisUNASSIGNEDand Jira is configured to allow unassigned issues.PROJECT_DEFAULTwhen none of the preceding cases are true
- name? string - The name for the component
- self? string - The URL for this count of the issues contained in the component
- realAssignee? User - The user assigned to issues created with this component, when
assigneeTypedoes not identify a valid assignee
- assignee? User - The details of the user associated with
assigneeType, if any. SeerealAssigneefor details of the user assigned to issues created with this component
- assigneeType? "PROJECT_DEFAULT"|"COMPONENT_LEAD"|"PROJECT_LEAD"|"UNASSIGNED" - The nominal user type used to determine the assignee for issues created with this component. See
realAssigneeTypefor details on how the type of the user, and hence the user, assigned to issues is determined. Takes the following values:PROJECT_LEADthe assignee to any issues created with this component is nominally the lead for the project the component is in.COMPONENT_LEADthe assignee to any issues created with this component is nominally the lead for the component.UNASSIGNEDan assignee is not set for issues created with this component.PROJECT_DEFAULTthe assignee to any issues created with this component is nominally the default assignee for the project that the component is in
- id? string - The unique identifier for the component
- projectId? int - Not used
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 "and"|"or"|"not" - The operator between the clauses
jira: ConditionGroupConfiguration
Closed record
The conditions group associated with the transition
Fields
- conditionGroups? ConditionGroupConfiguration[] - The nested conditions of the condition group
- conditions? WorkflowRuleConfiguration[] - The rules for this condition
- operation? "ANY"|"ALL" - Determines how the conditions in the group are evaluated. Accepts either
ANYorALL. IfANYis used, at least one condition in the group must be true for the group to evaluate to true. IfALLis used, all conditions in the group must be true for the group to evaluate to true
jira: ConditionGroupPayload
Closed record
The payload for creating a condition group in a workflow
Fields
- conditionGroup? ConditionGroupPayload[] - The nested conditions of the condition group
- conditions? RulePayload[] - The rules for this condition
- operation? "ANY"|"ALL" - Determines how the conditions in the group are evaluated. Accepts either
ANYorALL. IfANYis used, at least one condition in the group must be true for the group to evaluate to true. IfALLis used, all conditions in the group must be true for the group to evaluate to true
jira: ConditionGroupUpdate
Closed record
The conditions group associated with the transition
Fields
- conditionGroups? ConditionGroupUpdate[] - The nested conditions of the condition group
- conditions? WorkflowRuleConfiguration[] - The rules for this condition
- operation "ANY"|"ALL" - Determines how the conditions in the group are evaluated. Accepts either
ANYorALL. IfANYis used, at least one condition in the group must be true for the group to evaluate to true. IfALLis used, all conditions in the group must be true for the group to evaluate to true
jira: Configuration
Closed record
Details about the configuration of Jira
Fields
- unassignedIssuesAllowed? boolean - Whether the ability to create unassigned 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
- attachmentsEnabled? boolean - Whether the ability to add attachments to issues is enabled
- timeTrackingEnabled? boolean - Whether the ability to track time is enabled. This property is deprecated
- issueLinkingEnabled? boolean - Whether the ability to link issues is enabled
- subTasksEnabled? boolean - Whether the ability to create subtasks for issues is enabled
- votingEnabled? boolean - Whether the ability for users to vote on issues is enabled. See Configuring Jira application options for details
- timeTrackingConfiguration? TimeTrackingConfiguration - The configuration of time tracking
jira: ConfigurationsListParameters
Closed record
List of custom fields identifiers which will be used to filter configurations
Fields
- fieldIdsOrKeys string[] - List of IDs or keys of the custom fields. It can be a mix of IDs and keys in the same query
jira: ConnectCustomFieldValue
A list of custom field details
Fields
- number? decimal - The value of number type custom field when
_typeisNumberIssueField
- issueID int - The issue ID
- 'string? string - The value of string type custom field when
_typeisStringIssueField
- 'type "StringIssueField"|"NumberIssueField"|"RichTextIssueField"|"SingleSelectIssueField"|"MultiSelectIssueField"|"TextIssueField" - The type of custom field
- optionID? string - The value of single select and multiselect custom field type when
_typeisSingleSelectIssueFieldorMultiSelectIssueField
- text? string - The value of of text custom field type when
_typeisTextIssueField
- richText? string - The value of richText type custom field when
_typeisRichTextIssueField
- fieldID int - The custom field ID
jira: ConnectCustomFieldValues
Closed record
Details of updates for a custom field
Fields
- updateValueList? ConnectCustomFieldValue[] - The list of custom field update details
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(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- followRedirects? FollowRedirects - Configurations associated with Redirection
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache CacheConfig(default {}) - 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(default {}) - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
- laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. 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
modulesproperty in the app descriptor
jira: ContainerForProjectFeatures
Closed record
The list of features on a project
Fields
- features? ProjectFeature[] - The project features
jira: ContainerForRegisteredWebhooks
Closed record
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
Closed record
Container for a list of webhook IDs
Fields
- webhookIds int[] - A list of webhook IDs
jira: ContainerOfWorkflowSchemeAssociations
Closed record
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: ContentItem
Closed record
Represents the content to redact
Fields
- entityType "issuefieldvalue" - The type of the entity to redact
- entityId string - The ID of the content entity. For redacting a issue field, this will be field id. e.g. summary, customfield_10000
- id string - This would be the issue ID
jira: Context
Closed record
A context
Fields
- scope? Scope - The scope of the context
- name? string - The name of the context
- id? int - The ID of the context
jira: ContextForProjectAndIssueType
Closed record
The project and issue type mapping with a matching custom field context
Fields
- issueTypeId string - The ID of the issue type
- contextId string - The ID of the custom field context
- projectId string - The ID of the project
jira: ContextualConfiguration
Closed record
Details of the contextual configuration for a custom field
Fields
- fieldContextId string - The ID of the field context the configuration is associated with
- schema? anydata - The field value schema
- configuration? anydata - The field configuration
- id string - The ID of the configuration
jira: ConvertedJQLQueries
Closed record
The converted JQL queries
Fields
- queriesWithUnknownUsers? JQLQueryWithUnknownUsers[] - List of queries containing user information that could not be mapped to an existing user
- queryStrings? string[] - The list of converted query strings with account IDs in place of user identifiers
jira: CopyDashboardQueries
Represents the Queries record for the operation: copyDashboard
Fields
- extendAdminPermissions boolean(default false) - Whether admin level permissions are used. It should only be true if the user has Administer Jira global permission
jira: CreateCrossProjectReleaseRequest
Closed record
Fields
- releaseIds? int[] - The IDs of the releases to include in the cross-project release
- name string - The cross-project release name
jira: CreateCustomFieldContext
Closed record
The details of a created custom field context
Fields
- issueTypeIds? string[] - The list of issue types IDs for the context. If the list is empty, the context refers to all issue types
- name string - The name of the context
- description? string - The description of the context
- id? string - The ID of the context
- projectIds? string[] - The list of project IDs associated with the context. If the list is empty, the context is global
jira: CreateCustomFieldRequest
Closed record
Fields
- filter? boolean - Allows filtering issues based on their values for the custom field
- customFieldId int - The custom field ID
jira: CreateDashboardQueries
Represents the Queries record for the operation: createDashboard
Fields
- extendAdminPermissions boolean(default false) - Whether admin level permissions are used. It should only be true if the user has Administer Jira global permission
jira: CreateDateFieldRequest
Closed record
Fields
- dateCustomFieldId? int - A date custom field ID. This is required if the type is "DateCustomField"
- 'type "DueDate"|"TargetStartDate"|"TargetEndDate"|"DateCustomField" - The date field type. This must be "DueDate", "TargetStartDate", "TargetEndDate" or "DateCustomField"
jira: CreatedIssue
Closed record
Details about a created issue or subtask
Fields
- self? string - The URL of the created issue or subtask
- watchers? NestedResponse - The response code and messages related to any requested watchers
- id? string - The ID of the created issue or subtask
- 'key? string - The key of the created issue or subtask
- transition? NestedResponse - The response code and messages related to any requested transition
jira: CreatedIssues
Closed record
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: CreateExclusionRulesRequest
Closed record
Fields
- workStatusIds? int[] - The IDs of the work statuses to exclude from the plan
- releaseIds? int[] - The IDs of the releases to exclude from the plan
- numberOfDaysToShowCompletedIssues? Signed32 - Issues completed this number of days ago will be excluded from the plan
- issueTypeIds? int[] - The IDs of the issue types to exclude from the plan
- workStatusCategoryIds? int[] - The IDs of the work status categories to exclude from the plan
- issueIds? int[] - The IDs of the issues to exclude from the plan
jira: CreateFilterQueries
Represents the Queries record for the operation: createFilter
Fields
- expand? string - Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:
sharedUsersReturns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specifysharedUsers, then thesharedUsersobject is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append[start-index:end-index]to the expand request. For example, to access the next 1000 users, use?expand=sharedUsers[1001:2000].subscriptionsReturns the users that are subscribed to the filter. If you don't specifysubscriptions, thesubscriptionsobject is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append[start-index:end-index]to the expand request. For example, to access the next 1000 subscriptions, use?expand=subscriptions[1001:2000]
jira: CreateIssueQueries
Represents the Queries record for the operation: createIssue
Fields
- 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
jira: CreateIssueSecuritySchemeDetails
Issue security scheme and it's details
Fields
- description? string - The description of the issue security scheme.
- levels? SecuritySchemeLevelBean[] - The list of scheme levels which should be added to the security scheme.
- name string - The name of the issue security scheme. Must be unique (case-insensitive).
jira: CreateIssueSourceRequest
Closed record
Fields
- 'type "Board"|"Project"|"Filter" - The issue source type. This must be "Board", "Project" or "Filter"
- value int - The issue source value. This must be a board ID if the type is "Board", a project ID if the type is "Project" or a filter ID if the type is "Filter"
jira: CreateIssueTypeAvatarQueries
Represents the Queries record for the operation: createIssueTypeAvatar
Fields
- size Signed32 - The length of each side of the crop region
- x Signed32(default 0) - The X coordinate of the top-left corner of the crop region
- y Signed32(default 0) - The Y coordinate of the top-left corner of the crop region
jira: CreateNotificationSchemeDetails
Details of an notification scheme
Fields
- description? string - The description of the notification scheme.
- name string - The name of the notification scheme. Must be unique (case-insensitive).
- notificationSchemeEvents? NotificationSchemeEventDetails[] - The list of notifications which should be added to the notification scheme.
jira: CreatePermissionGrantQueries
Represents the Queries record for the operation: createPermissionGrant
Fields
- expand? string - 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:
permissionsReturns all permission grants for each permission scheme.userReturns information about the user who is granted the permission.groupReturns information about the group that is granted the permission.projectRoleReturns information about the project role granted the permission.fieldReturns information about the custom field granted the permission.allReturns all expandable information
jira: CreatePermissionHolderRequest
Closed record
Fields
- 'type "Group"|"AccountId" - The permission holder type. This must be "Group" or "AccountId"
- value string - The permission holder value. This must be a group name if the type is "Group" or an account ID if the type is "AccountId"
jira: CreatePermissionRequest
Closed record
Fields
- holder CreatePermissionHolderRequest - The permission holder
- 'type "View"|"Edit" - The permission type. This must be "View" or "Edit"
jira: CreatePermissionSchemeQueries
Represents the Queries record for the operation: createPermissionScheme
Fields
- expand? string - 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:
allReturns all expandable information.fieldReturns information about the custom field granted the permission.groupReturns information about the group that is granted the permission.permissionsReturns all permission grants for each permission scheme.projectRoleReturns information about the project role granted the permission.userReturns information about the user who is granted the permission
jira: CreatePlanOnlyTeamRequest
Closed record
Fields
- planningStyle "Scrum"|"Kanban" - The planning style for the plan-only team. This must be "Scrum" or "Kanban"
- memberAccountIds? string[] - The account IDs of the plan-only team members
- issueSourceId? int - The ID of the issue source for the plan-only team
- name string - The plan-only team name
- sprintLength? int - The sprint length for the plan-only team
- capacity? decimal - The capacity for the plan-only team
jira: CreatePlanQueries
Represents the Queries record for the operation: createPlan
Fields
- useGroupId boolean(default false) - Whether to accept group IDs instead of group names. Group names are deprecated
jira: CreatePlanRequest
Closed record
Fields
- crossProjectReleases? CreateCrossProjectReleaseRequest[] - The cross-project releases to include in the plan
- customFields? CreateCustomFieldRequest[] - The custom fields for the plan
- issueSources CreateIssueSourceRequest[] - The issue sources to include in the plan
- permissions? CreatePermissionRequest[] - The permissions for the plan
- name string - The plan name
- scheduling CreateSchedulingRequest - The scheduling settings for the plan
- leadAccountId? string - The account ID of the plan lead
- exclusionRules? CreateExclusionRulesRequest - The exclusion rules for the plan
jira: CreatePriorityDetails
Details of an issue priority
Fields
- avatarId? int - The ID for the avatar for the priority. Either the iconUrl or avatarId must be defined, but not both. This parameter is nullable and will become mandatory once the iconUrl parameter is deprecated.
- description? string? - The description of the priority.
- iconUrl? "/images/icons/priorities/blocker.png"|"/images/icons/priorities/critical.png"|"/images/icons/priorities/high.png"|"/images/icons/priorities/highest.png"|"/images/icons/priorities/low.png"|"/images/icons/priorities/lowest.png"|"/images/icons/priorities/major.png"|"/images/icons/priorities/medium.png"|"/images/icons/priorities/minor.png"|"/images/icons/priorities/trivial.png"|"/images/icons/priorities/blocker_new.png"|"/images/icons/priorities/critical_new.png"|"/images/icons/priorities/high_new.png"|"/images/icons/priorities/highest_new.png"|"/images/icons/priorities/low_new.png"|"/images/icons/priorities/lowest_new.png"|"/images/icons/priorities/major_new.png"|"/images/icons/priorities/medium_new.png"|"/images/icons/priorities/minor_new.png"|"/images/icons/priorities/trivial_new.png"? - The URL of an icon for the priority. Accepted protocols are HTTP and HTTPS. Built in icons can also be used. Either the iconUrl or avatarId must be defined, but not both.
- name string - The name of the priority. Must be unique.
- statusColor string - The status color of the priority in 3-digit or 6-digit hexadecimal format.
jira: CreatePrioritySchemeDetails
Closed record
Details of a new priority scheme
Fields
- priorityIds CreatePrioritySchemeDetailsPriorityIdsItemsInteger[] - The IDs of priorities in the scheme
- mappings? PriorityMapping - Instructions to migrate the priorities of issues.
inmappings are used to migrate the priorities of issues to priorities used within the priority scheme.outmappings are used to migrate the priorities of issues to priorities not used within the priority scheme.- When priorities are added to the new priority scheme, no mapping needs to be provided as the new priorities are not used by any issues.
- When priorities are removed from the new priority scheme, no mapping needs to be provided as the removed priorities are not used by any issues.
- When projects are added to the priority scheme, the priorities of issues in those projects might need to be migrated to new priorities used by the priority scheme. This can occur when the current scheme does not use all the priorities in the project(s)' priority scheme(s).
-
An
inmapping must be provided for each of these priorities. - When projects are removed from the priority scheme, no mapping needs to be provided as the removed projects are not using the priorities of the new priority scheme.
inandoutmappings, see the child properties documentation for thePriorityMappingobject below
- defaultPriorityId int - The ID of the default priority for the priority scheme
- name string - The name of the priority scheme. Must be unique
- description? string - The description of the priority scheme
- projectIds? int[] - The IDs of projects that will use the priority scheme
jira: CreateProjectAvatarQueries
Represents the Queries record for the operation: createProjectAvatar
Fields
- size Signed32(default 0) - The length of each side of the crop region
- x Signed32(default 0) - The X coordinate of the top-left corner of the crop region
- y Signed32(default 0) - The Y coordinate of the top-left corner of the crop region
jira: CreateProjectDetails
Closed record
Details about the project
Fields
- 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
- description? string - A brief description of the project
- leadAccountId? string - The account ID of the project lead. Either
leadorleadAccountIdmust be set when creating a project. Cannot be provided withlead
- lead? string - This parameter is deprecated because of privacy changes. Use
leadAccountIdinstead. See the migration guide for details. The user name of the project lead. EitherleadorleadAccountIdmust be set when creating a project. Cannot be provided withleadAccountId
- url? string - A link to information about this project, such as project documentation
- 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
- 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
- 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
- projectTemplateKey? "com.pyxis.greenhopper.jira:gh-simplified-agility-kanban"|"com.pyxis.greenhopper.jira:gh-simplified-agility-scrum"|"com.pyxis.greenhopper.jira:gh-simplified-basic"|"com.pyxis.greenhopper.jira:gh-simplified-kanban-classic"|"com.pyxis.greenhopper.jira:gh-simplified-scrum-classic"|"com.pyxis.greenhopper.jira:gh-cross-team-template"|"com.pyxis.greenhopper.jira:gh-cross-team-planning-template"|"com.atlassian.servicedesk:simplified-it-service-management"|"com.atlassian.servicedesk:simplified-it-service-management-basic"|"com.atlassian.servicedesk:simplified-it-service-management-operations"|"com.atlassian.servicedesk:simplified-general-service-desk"|"com.atlassian.servicedesk:simplified-general-service-desk-it"|"com.atlassian.servicedesk:simplified-general-service-desk-business"|"com.atlassian.servicedesk:simplified-internal-service-desk"|"com.atlassian.servicedesk:simplified-external-service-desk"|"com.atlassian.servicedesk:simplified-hr-service-desk"|"com.atlassian.servicedesk:simplified-facilities-service-desk"|"com.atlassian.servicedesk:simplified-legal-service-desk"|"com.atlassian.servicedesk:simplified-marketing-service-desk"|"com.atlassian.servicedesk:simplified-finance-service-desk"|"com.atlassian.servicedesk:simplified-analytics-service-desk"|"com.atlassian.servicedesk:simplified-design-service-desk"|"com.atlassian.servicedesk:simplified-sales-service-desk"|"com.atlassian.servicedesk:simplified-halp-service-desk"|"com.atlassian.servicedesk:simplified-blank-project-it"|"com.atlassian.servicedesk:simplified-blank-project-business"|"com.atlassian.servicedesk:next-gen-it-service-desk"|"com.atlassian.servicedesk:next-gen-hr-service-desk"|"com.atlassian.servicedesk:next-gen-legal-service-desk"|"com.atlassian.servicedesk:next-gen-marketing-service-desk"|"com.atlassian.servicedesk:next-gen-facilities-service-desk"|"com.atlassian.servicedesk:next-gen-general-service-desk"|"com.atlassian.servicedesk:next-gen-general-it-service-desk"|"com.atlassian.servicedesk:next-gen-general-business-service-desk"|"com.atlassian.servicedesk:next-gen-analytics-service-desk"|"com.atlassian.servicedesk:next-gen-finance-service-desk"|"com.atlassian.servicedesk:next-gen-design-service-desk"|"com.atlassian.servicedesk:next-gen-sales-service-desk"|"com.atlassian.jira-core-project-templates:jira-core-simplified-content-management"|"com.atlassian.jira-core-project-templates:jira-core-simplified-document-approval"|"com.atlassian.jira-core-project-templates:jira-core-simplified-lead-tracking"|"com.atlassian.jira-core-project-templates:jira-core-simplified-process-control"|"com.atlassian.jira-core-project-templates:jira-core-simplified-procurement"|"com.atlassian.jira-core-project-templates:jira-core-simplified-project-management"|"com.atlassian.jira-core-project-templates:jira-core-simplified-recruitment"|"com.atlassian.jira-core-project-templates:jira-core-simplified-task-" - A predefined configuration for a project. The type of the
projectTemplateKeymust match with the type of theprojectTypeKey
- name string - The name of the project
- 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
- 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
- assigneeType? "PROJECT_LEAD"|"UNASSIGNED" - The default assignee when creating issues for this project
- 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
- projectTypeKey? "software"|"service_desk"|"business" - 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
- categoryId? int - The ID of the project's category. A complete list of category IDs is found using the Get all project categories operation
- '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
jira: CreateResolutionDetails
Details of an issue resolution
Fields
- description? string - The description of the resolution.
- name string - The name of the resolution. Must be unique (case-insensitive).
jira: CreateSchedulingRequest
Closed record
Fields
- estimation "StoryPoints"|"Days"|"Hours" - The estimation unit for the plan. This must be "StoryPoints", "Days" or "Hours"
- inferredDates? "None"|"SprintDates"|"ReleaseDates" - The inferred dates for the plan. This must be "None", "SprintDates" or "ReleaseDates"
- endDate? CreateDateFieldRequest - The end date field for the plan
- startDate? CreateDateFieldRequest - The start date field for the plan
- dependencies? "Sequential"|"Concurrent" - The dependencies for the plan. This must be "Sequential" or "Concurrent"
jira: CreateUiModificationDetails
Closed record
The details of a UI modification
Fields
- data? string - The data of the UI modification. The maximum size of the data is 50000 characters
- name string - The name of the UI modification. The maximum length is 255 characters
- description? string - The description of the UI modification. The maximum length is 255 characters
- contexts? UiModificationContextDetails[] - List of contexts of the UI modification. The maximum number of contexts is 1000
jira: CreateUpdateRoleRequestBean
Closed record
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: CreateWorkflowCondition
Closed record
A workflow transition condition
Fields
- configuration? record {} - EXPERIMENTAL. The configuration of the transition rule
- conditions? CreateWorkflowCondition[] - The list of workflow conditions
- 'type? string - The type of the transition rule
- operator? "AND"|"OR" - The compound condition operator
jira: CreateWorkflowDetails
Closed record
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
- statuses CreateWorkflowStatusDetails[] - The statuses of the workflow. Any status that does not include a transition is added to the workflow without a transition
- transitions CreateWorkflowTransitionDetails[] - The transitions of the workflow. For the request to be valid, these transitions must:
- include one initial transition.
- not use the same name for a global and directed transition.
- have a unique name for each global transition.
- have a unique 'to' status for each global transition.
- have unique names for each transition from a status.
- not have a 'from' status on initial and global transitions.
- have a 'from' status on directed transitions.
statuses
jira: CreateWorkflowStatusDetails
Closed record
The details of a transition status
Fields
- id string - The ID of the status
- properties? record { string... } - The properties of the status
jira: CreateWorkflowTransitionDetails
Closed record
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
- screen? CreateWorkflowTransitionScreenDetails - The screen of the transition
- 'from? string[] - The statuses the transition can start from
- rules? CreateWorkflowTransitionRulesDetails - The rules of the transition
- to string - The status the transition goes to
- 'type "global"|"initial"|"directed" - The type of the transition
- properties? record { string... } - The properties of the transition
jira: CreateWorkflowTransitionPropertyQueries
Represents the Queries record for the operation: createWorkflowTransitionProperty
Fields
- workflowMode "live"|"draft" (default "live") - The workflow status. Set to live for inactive workflows or draft for draft workflows. Active workflows cannot be edited
- workflowName string - The name of the workflow that the transition belongs to
- '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
keydefined in the request body
jira: CreateWorkflowTransitionRule
Closed record
A workflow transition rule
Fields
- configuration? record {} - EXPERIMENTAL. The configuration of the transition rule
- 'type string - The type of the transition rule
jira: CreateWorkflowTransitionRulesDetails
Closed record
The details of a workflow transition rules
Fields
- postFunctions? CreateWorkflowTransitionRule[] - The workflow post functions. Note: The default post functions are always added to the initial transition, as in: "postFunctions": [ { "type": "IssueCreateFunction" }, { "type": "IssueReindexFunction" }, { "type": "FireIssueEventFunction", "configuration": { "event": { "id": "1", "name": "issue_created" } } } ] Note: The default post functions are always added to the global and directed transitions, as in: "postFunctions": [ { "type": "UpdateIssueStatusFunction" }, { "type": "CreateCommentFunction" }, { "type": "GenerateChangeHistoryFunction" }, { "type": "IssueReindexFunction" }, { "type": "FireIssueEventFunction", "configuration": { "event": { "id": "13", "name": "issue_generic" } } } ]
- validators? CreateWorkflowTransitionRule[] - The workflow validators. Note: The default permission validator is always added to the initial transition, as in: "validators": [ { "type": "PermissionValidator", "configuration": { "permissionKey": "CREATE_ISSUES" } } ]
- conditions? CreateWorkflowCondition - The workflow conditions
jira: CreateWorkflowTransitionScreenDetails
Closed record
The details of a transition screen
Fields
- id string - The ID of the screen
jira: CustomFieldConfigurations
Closed record
Details of configurations for a custom field
Fields
- configurations ContextualConfiguration[] - The list of custom field configuration details
jira: CustomFieldContext
Closed record
The details of a custom field context
Fields
- name string - The name of the context
- description string - The description of the context
- id string - The ID of the context
- isAnyIssueType boolean - Whether the context apply to all issue types
- isGlobalContext boolean - Whether the context is global
jira: CustomFieldContextDefaultValueCascadingOption
The default value for a cascading select custom field
Fields
- contextId string - The ID of the context
- optionId string - The ID of the default option
- 'type string -
- cascadingOptionId? string - The ID of the default cascading option
jira: CustomFieldContextDefaultValueDate
The default value for a Date custom field
Fields
- date? string - The default date in ISO format. Ignored if
useCurrentis true
- useCurrent boolean(default false) - Whether to use the current date
- 'type string -
jira: CustomFieldContextDefaultValueDateTime
The default value for a date time custom field
Fields
- dateTime? string - The default date-time in ISO format. Ignored if
useCurrentis true
- useCurrent boolean(default false) - Whether to use the current date
- 'type string -
jira: CustomFieldContextDefaultValueFloat
Default value for a float (number) custom field
Fields
- number decimal - The default floating-point number
- 'type string -
jira: CustomFieldContextDefaultValueForgeDateTimeField
The default value for a Forge date time custom field
Fields
- dateTime? string - The default date-time in ISO format. Ignored if
useCurrentis true
- contextId string - The ID of the context
- useCurrent boolean(default false) - Whether to use the current date
- 'type string -
jira: CustomFieldContextDefaultValueForgeGroupField
The default value for a Forge group custom field
Fields
- groupId string - The ID of the the default group
- contextId string - The ID of the context
- 'type string -
jira: CustomFieldContextDefaultValueForgeMultiGroupField
The default value for a Forge collection of groups custom field
Fields
- groupIds string[] - The IDs of the default groups
- contextId string - The ID of the context
- 'type string -
jira: CustomFieldContextDefaultValueForgeMultiStringField
The default text for a Forge collection of strings custom field
Fields
- values? string[] - List of string values. The maximum length for a value is 254 characters
- 'type string -
jira: CustomFieldContextDefaultValueForgeMultiUserField
Defaults for a Forge collection of users custom field
Fields
- accountIds string[] - The IDs of the default users
- contextId string - The ID of the context
- 'type string -
jira: CustomFieldContextDefaultValueForgeNumberField
Default value for a Forge number custom field
Fields
- number decimal - The default floating-point number
- contextId string - The ID of the context
- 'type string -
jira: CustomFieldContextDefaultValueForgeObjectField
The default value for a Forge object custom field
Fields
- 'type string -
- 'object? record {} - The default JSON object
jira: CustomFieldContextDefaultValueForgeStringField
The default text for a Forge string custom field
Fields
- contextId string - The ID of the context
- text? string - The default text. The maximum length is 254 characters
- 'type string -
jira: CustomFieldContextDefaultValueForgeUserField
Defaults for a Forge user custom field
Fields
- accountId string - The ID of the default user
- contextId string - The ID of the context
- userFilter UserFilter - Filter for a User Picker (single) custom field
- 'type string -
jira: CustomFieldContextDefaultValueLabels
Default value for a labels custom field
Fields
- 'type string -
- labels string[] - The default labels value
jira: CustomFieldContextDefaultValueMultipleGroupPicker
The default value for a multiple group picker custom field
Fields
- groupIds string[] - The IDs of the default groups
- contextId string - The ID of the context
- 'type string -
jira: CustomFieldContextDefaultValueMultipleOption
The default value for a multi-select custom field
Fields
- contextId string - The ID of the context
- 'type string -
- optionIds string[] - The list of IDs of the default options
jira: CustomFieldContextDefaultValueMultipleVersionPicker
The default value for a multiple version picker custom field
Fields
- versionOrder? string - The order the pickable versions are displayed in. If not provided, the released-first order is used. Available version orders are
"releasedFirst"and"unreleasedFirst"
- versionIds string[] - The IDs of the default versions
- 'type string -
jira: CustomFieldContextDefaultValueMultiUserPicker
The default value for a User Picker (multiple) custom field
Fields
- accountIds string[] - The IDs of the default users
- contextId string - The ID of the context
- 'type string -
jira: CustomFieldContextDefaultValueProject
The default value for a project custom field
Fields
- contextId string - The ID of the context
- 'type string -
- projectId string - The ID of the default project
jira: CustomFieldContextDefaultValueReadOnly
The default text for a read only custom field
Fields
- text? string - The default text. The maximum length is 255 characters
- 'type string -
jira: CustomFieldContextDefaultValueSingleGroupPicker
The default value for a group picker custom field
Fields
- groupId string - The ID of the the default group
- contextId string - The ID of the context
- 'type string -
jira: CustomFieldContextDefaultValueSingleOption
The 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 -
jira: CustomFieldContextDefaultValueSingleVersionPicker
The default value for a version picker custom field
Fields
- versionId string - The ID of the default version
- versionOrder? string - The order the pickable versions are displayed in. If not provided, the released-first order is used. Available version orders are
"releasedFirst"and"unreleasedFirst"
- 'type string -
jira: CustomFieldContextDefaultValueTextArea
The default text for a text area custom field
Fields
- text? string - The default text. The maximum length is 32767 characters
- 'type string -
jira: CustomFieldContextDefaultValueTextField
The default text for a text custom field
Fields
- text? string - The default text. The maximum length is 254 characters
- 'type string -
jira: CustomFieldContextDefaultValueUpdate
Closed record
Default values to update
Fields
- defaultValues? CustomFieldContextDefaultValue[] -
jira: CustomFieldContextDefaultValueURL
The default value for a URL custom field
Fields
- contextId string - The ID of the context
- 'type string -
- url string - The default URL
jira: CustomFieldContextOption
Closed record
Details of the custom field options for a context
Fields
- disabled boolean - Whether the option is disabled
- optionId? string - For cascading options, the ID of the custom field option containing the cascading option
- id string - The ID of the custom field option
- value string - The value of the custom field option
jira: CustomFieldContextProjectMapping
Closed record
Details of a context to project association
Fields
- contextId string - The ID of the context
- projectId? string - The ID of the project
- isGlobalContext? boolean - Whether context is global
jira: CustomFieldContextSingleUserPickerDefaults
Defaults for a User Picker (single) custom field
Fields
- accountId string - The ID of the default user
- contextId string - The ID of the context
- userFilter UserFilter - Filter for a User Picker (single) custom field
- 'type string -
jira: CustomFieldContextUpdateDetails
Closed record
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
Closed record
A list of custom field options for a context
Fields
- options? CustomFieldContextOption[] - The created custom field options
jira: CustomFieldDefinitionJsonBean
Closed record
Fields
- searcherKey? "com.atlassian.jira.plugin.system.customfieldtypes:cascadingselectsearcher"|"com.atlassian.jira.plugin.system.customfieldtypes:daterange"|"com.atlassian.jira.plugin.system.customfieldtypes:datetimerange"|"com.atlassian.jira.plugin.system.customfieldtypes:exactnumber"|"com.atlassian.jira.plugin.system.customfieldtypes:exacttextsearcher"|"com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher"|"com.atlassian.jira.plugin.system.customfieldtypes:labelsearcher"|"com.atlassian.jira.plugin.system.customfieldtypes:multiselectsearcher"|"com.atlassian.jira.plugin.system.customfieldtypes:numberrange"|"com.atlassian.jira.plugin.system.customfieldtypes:projectsearcher"|"com.atlassian.jira.plugin.system.customfieldtypes:textsearcher"|"com.atlassian.jira.plugin.system.customfieldtypes:userpickergroupsearcher"|"com.atlassian.jira.plugin.system.customfieldtypes:versionsearcher" - 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:cascadingselectsearcherdatepicker:daterangedatetime:datetimerangefloat:exactnumberornumberrangegrouppicker:grouppickersearcherimportid:exactnumberornumberrangelabels:labelsearchermulticheckboxes:multiselectsearchermultigrouppicker:multiselectsearchermultiselect:multiselectsearchermultiuserpicker:userpickergroupsearchermultiversion:versionsearcherproject:projectsearcherradiobuttons:multiselectsearcherreadonlyfield:textsearcherselect:multiselectsearchertextarea:textsearchertextfield:textsearcherurl:exacttextsearcheruserpicker:userpickergroupsearcherversion:versionsearcher
- name string - The name of the custom field, which is displayed in Jira. This is not the unique identifier
- description? string - The description of the custom field, which is displayed in Jira
- 'type string - The type of the custom field. These built-in custom field types are available:
cascadingselect: Enables values to be selected from two levels of select lists (value:com.atlassian.jira.plugin.system.customfieldtypes:cascadingselect)datepicker: Stores a date using a picker control (value:com.atlassian.jira.plugin.system.customfieldtypes:datepicker)datetime: Stores a date with a time component (value:com.atlassian.jira.plugin.system.customfieldtypes:datetime)float: Stores and validates a numeric (floating point) input (value:com.atlassian.jira.plugin.system.customfieldtypes:float)grouppicker: Stores a user group using a picker control (value:com.atlassian.jira.plugin.system.customfieldtypes:grouppicker)importid: A read-only field that stores the ID the issue had in the system it was imported from (value:com.atlassian.jira.plugin.system.customfieldtypes:importid)labels: Stores labels (value:com.atlassian.jira.plugin.system.customfieldtypes:labels)multicheckboxes: Stores multiple values using checkboxes (value:) MISSING[] *multigrouppicker: Stores multiple user groups using a picker control (value:) MISSING[]*multiselect: Stores multiple values using a select list (value:com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes)multiuserpicker: Stores multiple users using a picker control (value:com.atlassian.jira.plugin.system.customfieldtypes:multigrouppicker)multiversion: Stores multiple versions from the versions available in a project using a picker control (value:com.atlassian.jira.plugin.system.customfieldtypes:multiversion)project: Stores a project from a list of projects that the user is permitted to view (value:com.atlassian.jira.plugin.system.customfieldtypes:project)radiobuttons: Stores a value using radio buttons (value:com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons)readonlyfield: Stores a read-only text value, which can only be populated via the API (value:com.atlassian.jira.plugin.system.customfieldtypes:readonlyfield)select: Stores a value from a configurable list of options (value:com.atlassian.jira.plugin.system.customfieldtypes:select)textarea: Stores a long text string using a multiline text area (value:com.atlassian.jira.plugin.system.customfieldtypes:textarea)textfield: Stores a text string using a single-line text box (value:com.atlassian.jira.plugin.system.customfieldtypes:textfield)url: Stores a URL (value:com.atlassian.jira.plugin.system.customfieldtypes:url)userpicker: Stores a user using a picker control (value:com.atlassian.jira.plugin.system.customfieldtypes:userpicker)version: Stores a version using a picker control (value:com.atlassian.jira.plugin.system.customfieldtypes:version)
ari:cloud:ecosystem::extension/e62f20a2-4b61-4dbe-bfb9-9a88b5e3ac84/548c5df1-24aa-4f7c-bbbb-3038d947cb05/static/my-cf-type-key
jira: CustomFieldOption
Closed record
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
Closed record
Details of a custom field option to create
Fields
- disabled? boolean - Whether the option is disabled
- optionId? string - For cascading options, the ID of a parent option
- value string - The value of the custom field option
jira: CustomFieldOptionUpdate
Closed record
Details of a custom field option for a context
Fields
- disabled? boolean - Whether the option is disabled
- id string - The ID of the custom field option
- value? string - The value of the custom field option
jira: CustomFieldPayload
Closed record
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
Fields
- searcherKey? string - The searcher key of the custom field
- onConflict? "FAIL"|"USE"|"NEW" - The strategy to use when there is a conflict with an existing custom field. FAIL - Fail execution, this always needs to be unique; USE - Use the existing entity and ignore new entity parameters
- cfType? string - The type of the custom field
- name? string - The name of the custom field
- description? string - The description of the custom field
- pcri? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
jira: CustomFieldReplacement
Closed record
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
Closed record
A list of custom field options for a context
Fields
- options? CustomFieldOptionUpdate[] - The updated custom field options
jira: CustomFieldValueUpdate
Closed record
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:
stringthe value must be a string.numberthe value must be a number.datetimethe value must be a string that represents a date in the ISO format or the simplified extended ISO format. For example,"2023-01-18T12:00:00-03:00"or"2023-01-18T12:00:00.000Z". However, the milliseconds part is ignored.userthe value must be an object that contains theaccountIdfield.groupthe value must be an object that contains the groupnameorgroupIdfield. Because group names can change, we recommend usinggroupId.
listcollection type
jira: CustomFieldValueUpdateDetails
Closed record
Details of updates for a custom field
Fields
- updates? CustomFieldValueUpdate[] - The list of custom field update details
jira: CustomTemplateRequestDTO
Closed record
The specific request object for creating a project with template
Fields
- issueType? IssueTypeProjectCreatePayload? - The payload for creating issue types in a project
- notification? NotificationSchemePayload? - The payload for creating a notification scheme. The user has to supply the ID for the default notification scheme. For CMP this is provided in the project payload and should be left empty, for TMP it's provided using this payload
- security? SecuritySchemePayload? - The payload for creating a security scheme. See https://support.atlassian.com/jira-cloud-administration/docs/configure-issue-security-schemes/
- role? RolesCapabilityPayload? -
- 'field? FieldCapabilityPayload? - Defines the payload for the fields, screens, screen schemes, issue type screen schemes, field layouts, and field layout schemes
- workflow? WorkflowCapabilityPayload? - The payload for creating a workflows. See https://www.atlassian.com/software/jira/guides/workflows/overview#what-is-a-jira-workflow
- scope? ScopePayload? - The payload for creating a scope. Defines if a project is team-managed project or company-managed project
- boards? BoardsPayload? -
- project? ProjectPayload - The payload for creating a project
- permissionScheme? PermissionPayloadDTO? - The payload to create a permission scheme
jira: CustomTemplatesProjectDetails
Closed record
Project Details
Fields
- enableComponents boolean(default false) - Whether components are enabled for the project. Only used by company-managed project
- avatarId? int - The ID of the project's avatar. Use the [Get project avatars](#api-rest-api-3-project-projectIdOrKey-avatar-get) operation to list the available avatars in a project
- accessLevel? "open"|"limited"|"private"|"free" - The access level of the project. Only used by team-managed project
- name? string - Name of the project
- description? string - Brief description of the project
- language? string - The default language for the project
- additionalProperties? record { string... } - Additional properties of the project
- assigneeType? "PROJECT_DEFAULT"|"COMPONENT_LEAD"|"PROJECT_LEAD"|"UNASSIGNED" - The default assignee when creating issues in the project
- leadAccountId? string - The account ID of the project lead. Either
leadorleadAccountIdmust be set when creating a project. Cannot be provided withlead
- categoryId? int - The ID of the project's category. A complete list of category IDs is found using the Get all project categories operation
- '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
- url? string - A link to information about this project, such as project documentation
jira: Dashboard
Closed record
Details of a dashboard
Fields
- owner? UserBean - The owner of the dashboard
- automaticRefreshMs? Signed32 - The automatic refresh interval for the dashboard in milliseconds
- description? string -
- isWritable? boolean - Whether the current user has permission to edit the dashboard
- view? string - The URL of the dashboard
- editPermissions? SharePermission[] - The details of any edit share permissions for the dashboard
- popularity? int - The number of users who have this dashboard as a favorite
- name? string - The name of the dashboard
- rank? Signed32 - The rank of this dashboard
- self? string - The URL of these dashboard details
- systemDashboard? boolean - Whether the current dashboard is system dashboard
- id? string - The ID of the dashboard
- isFavourite? boolean - Whether the dashboard is selected as a favorite by the user
jira: DashboardDetails
Closed record
Details of a dashboard
Fields
- editPermissions SharePermission[] - The edit permissions for the dashboard
- name string - The name of the dashboard
- description? string - The description of the dashboard
jira: DashboardGadget
Closed record
Details of a gadget
Fields
- color "blue"|"red"|"yellow"|"green"|"cyan"|"purple"|"gray"|"white" - The color of the gadget. Should be one of
blue,red,yellow,green,cyan,purple,gray, orwhite
- id int - The ID of the gadget instance
- position DashboardGadgetPosition - The position of the gadget
- title string - The title of the gadget
- uri? string - The URI of the gadget type
- moduleKey? string - The module key of the gadget type
jira: DashboardGadgetPosition
Closed record
Details of a gadget position
Fields
- theColumnPositionOfTheGadget Signed32 -
- theRowPositionOfTheGadget Signed32 -
jira: DashboardGadgetResponse
Closed record
The list of gadgets on the dashboard
Fields
- gadgets DashboardGadget[] - The list of gadgets
jira: DashboardGadgetSettings
Closed record
Details of the settings for a dashboard gadget
Fields
- color? string - The color of the gadget. Should be one of
blue,red,yellow,green,cyan,purple,gray, orwhite
- ignoreUriAndModuleKeyValidation? boolean - Whether to ignore the validation of module key and URI. For example, when a gadget is created that is a part of an application that isn't installed
- position? DashboardGadgetPosition - The position of the gadget. When the gadget is placed into the position, other gadgets in the same column are moved down to accommodate it
- title? string - The title of the gadget
- uri? string - The URI of the gadget type. Can't be provided with
moduleKey
- moduleKey? string - The module key of the gadget type. Can't be provided with
uri
jira: DashboardGadgetUpdateRequest
Closed record
The details of the gadget to update
Fields
- color? string - The color of the gadget. Should be one of
blue,red,yellow,green,cyan,purple,gray, orwhite
- position? DashboardGadgetPosition - The position of the gadget
- title? string - The title of the gadget
jira: DataClassificationLevelsBean
Closed record
The data classification
Fields
- classifications? DataClassificationTagBean[] - The data classifications
jira: DataClassificationTagBean
Closed record
The data classification
Fields
- color? string - The color of the data classification object
- guideline? string - The guideline of the data classification object
- name? string - The name of the data classification object
- description? string - The description of the data classification object
- rank? Signed32 - The rank of the data classification object
- id string - The ID of the data classification object
- status string - The status of the data classification object
jira: DateRangeFilterRequest
Closed record
List issues archived within a specified date range
Fields
- dateAfter string - List issues archived after a specified date, passed in the YYYY-MM-DD format
- dateBefore string - List issues archived before a specified date provided in the YYYY-MM-DD format
jira: DefaultLevelValue
Details of scheme and new default level
Fields
- defaultLevelId string - The ID of the issue security level to set as default for the specified scheme. Providing null will reset the default level.
- issueSecuritySchemeId string - The ID of the issue security scheme to set default level for.
jira: DefaultShareScope
Closed record
Details of the scope of the default sharing for new filters and dashboards
Fields
- scope "GLOBAL"|"AUTHENTICATED"|"PRIVATE" - The scope of the default sharing for new filters and dashboards:
AUTHENTICATEDShared with all logged-in users.GLOBALShared with all logged-in users. This shows asAUTHENTICATEDin the response.PRIVATENot shared with any users
jira: DefaultWorkflow
Closed record
Details about the default workflow
Fields
- 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
- workflow string - The name of the workflow to set as the default workflow
jira: DefaultWorkflowEditorResponse
Closed record
Fields
- value? "NEW"|"LEGACY" -
jira: DeleteActorQueries
Represents the Queries record for the operation: deleteActor
Fields
- groupId? string - The ID of the group to remove from the project role. This parameter cannot be used with the
groupparameter
- user? string - The user account ID of the user to remove from the project role
- group? string - The name of the group to remove from the project role. This parameter cannot be used with the
groupIdparameter. As a group's name can change, use ofgroupIdis recommended
jira: DeleteAndReplaceVersionBean
Closed record
Fields
- moveAffectedIssuesTo? int - The ID of the version to update
affectedVersionto when the field contains the deleted version
- moveFixIssuesTo? int - The ID of the version to update
fixVersionto 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: DeleteComponentQueries
Represents the Queries record for the operation: deleteComponent
Fields
- moveIssuesTo? string - The ID of the component to replace the deleted component. If this value is null no replacement is made
jira: DeleteDefaultWorkflowQueries
Represents the Queries record for the operation: deleteDefaultWorkflow
Fields
- updateDraftIfNeeded? boolean - 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
jira: DeleteDraftWorkflowMappingQueries
Represents the Queries record for the operation: deleteDraftWorkflowMapping
Fields
- workflowName string - The name of the workflow
jira: DeleteFavouriteForFilterQueries
Represents the Queries record for the operation: deleteFavouriteForFilter
Fields
- expand? string - Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:
sharedUsersReturns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specifysharedUsers, then thesharedUsersobject is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append[start-index:end-index]to the expand request. For example, to access the next 1000 users, use?expand=sharedUsers[1001:2000].subscriptionsReturns the users that are subscribed to the filter. If you don't specifysubscriptions, thesubscriptionsobject is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append[start-index:end-index]to the expand request. For example, to access the next 1000 subscriptions, use?expand=subscriptions[1001:2000]
jira: DeleteIssueQueries
Represents the Queries record for the operation: deleteIssue
Fields
- deleteSubtasks "true"|"false" (default "false") - Whether the issue's subtasks are deleted when the issue is deleted
jira: DeleteIssueTypeQueries
Represents the Queries record for the operation: deleteIssueType
Fields
- alternativeIssueTypeId? string - The ID of the replacement issue type
jira: DeleteProjectQueries
Represents the Queries record for the operation: deleteProject
Fields
- enableUndo boolean(default true) - Whether this project is placed in the Jira recycle bin where it will be available for restoration
jira: DeleteProjectRoleActorsFromRoleQueries
Represents the Queries record for the operation: deleteProjectRoleActorsFromRole
Fields
- groupId? string - The group ID of the group to be removed as a default actor. This parameter cannot be used with the
groupparameter
- user? string - The user account ID of the user to remove as a default actor
- group? string - The group name of the group to be removed as a default actor.This parameter cannot be used with the
groupIdparameter. As a group's name can change, use ofgroupIdis recommended
jira: DeleteProjectRoleQueries
Represents the Queries record for the operation: deleteProjectRole
Fields
- swap? int - The ID of the project role that will replace the one being deleted. The swap will attempt to swap the role in schemes (notifications, permissions, issue security), workflows, worklogs and comments
jira: DeleteRemoteIssueLinkByGlobalIdQueries
Represents the Queries record for the operation: deleteRemoteIssueLinkByGlobalId
Fields
- globalId string - The global ID of a remote issue link
jira: DeleteResolutionQueries
Represents the Queries record for the operation: deleteResolution
Fields
- replaceWith string(default "") - The ID of the issue resolution that will replace the currently selected resolution
jira: DeleteStatusesByIdQueries
Represents the Queries record for the operation: deleteStatusesById
Fields
- id string[] - The list of status IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001.
Min items
1, Max items50
jira: DeleteUserPropertyQueries
Represents the Queries record for the operation: deleteUserProperty
Fields
- accountId? string - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5
- userKey? string - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details
- username? string - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details
jira: DeleteVersionQueries
Represents the Queries record for the operation: deleteVersion
Fields
- moveAffectedIssuesTo? string - The ID of the version to update
affectedVersionto when the field contains the deleted version. The replacement version must be in the same project as the version being deleted and cannot be the version being deleted
- moveFixIssuesTo? string - The ID of the version to update
fixVersionto when the field contains the deleted version. The replacement version must be in the same project as the version being deleted and cannot be the version being deleted
jira: DeleteWorkflowMappingQueries
Represents the Queries record for the operation: deleteWorkflowMapping
Fields
- updateDraftIfNeeded boolean(default false) - 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
- workflowName string - The name of the workflow
jira: DeleteWorkflowSchemeIssueTypeQueries
Represents the Queries record for the operation: deleteWorkflowSchemeIssueType
Fields
- updateDraftIfNeeded boolean(default false) - 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
jira: DeleteWorkflowTransitionPropertyQueries
Represents the Queries record for the operation: deleteWorkflowTransitionProperty
Fields
- workflowMode? "live"|"draft" - The workflow status. Set to
livefor inactive workflows ordraftfor draft workflows. Active workflows cannot be edited
- workflowName string - The name of the workflow that the transition belongs to
- 'key string - The name of the transition property to delete, also known as the name of the property
jira: DeleteWorklogQueries
Represents the Queries record for the operation: deleteWorklog
Fields
- newEstimate? string - 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
adjustEstimateisnew
- adjustEstimate "new"|"leave"|"manual"|"auto" (default "auto") - Defines how to update the issue's time estimate, the options are:
newSets the estimate to a specific value, defined innewEstimate.leaveLeaves the estimate unchanged.manualIncreases the estimate by amount specified inincreaseBy.autoReduces the estimate by the value oftimeSpentin the worklog
- 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. Connect and Forge app users with admin permission can use this flag
- notifyUsers boolean(default true) - Whether users watching the issue are notified by email
- increaseBy? string - The amount to increase the issue's remaining estimate by, as days (#d), hours (#h), or minutes (#m or #). For example, 2d. Required when
adjustEstimateismanual
jira: DeprecatedWorkflow
Closed record
Details about a workflow
Fields
- default? boolean -
- lastModifiedDate? string - The datetime the workflow was last modified
- lastModifiedUserAccountId? string - The account ID of the user that last modified the workflow
- scope? Scope - The scope where this workflow applies
- name? string - The name of the workflow
- description? string - The description of the workflow
- lastModifiedUser? string - This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details
- steps? Signed32 - The number of steps included in the workflow
jira: DocumentVersion
Closed record
The current version details of this workflow scheme
Fields
- id? string - The version UUID
- versionNumber? int - The version number
jira: DuplicatePlanRequest
Closed record
Fields
- name string - The plan name
jira: DynamicModulesResourceRemoveModulesDeleteQueries
Represents the Queries record for the operation: DynamicModulesResource.removeModules_delete
Fields
- moduleKey? string[] - The key of the module to remove. To include multiple module keys, provide multiple copies of this parameter.
For example,
moduleKey=dynamic-attachment-entity-property&moduleKey=dynamic-select-field. Nonexistent keys are ignored
jira: EditIssueQueries
Represents the Queries record for the operation: editIssue
Fields
- expand string(default "") - The Get issue API expand parameter to use in the response if the
returnIssueparameter istrue
- overrideScreenSecurity boolean(default false) - Whether screen security is overridden to enable hidden fields to be edited. Available to Connect app users with Administer Jira global permission and Forge apps acting on behalf of users with Administer Jira global permission
- overrideEditableFlag boolean(default false) - Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect app users with Administer Jira global permission and Forge apps acting on behalf of users with Administer Jira global permission
- returnIssue boolean(default false) - Whether the response should contain the issue with fields edited in this request. The returned issue will have the same format as in the Get issue API
- 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
jira: EntityProperty
Closed record
An entity property, for more information see Entity properties
Fields
- value? anydata - The value of the property. Required on create and update
- 'key? string - The key of the property. Required on create and update
jira: EntityPropertyDetails
Fields
- entityId decimal - The entity property ID
- value string - The new value of the entity property
- 'key string - The entity property key
jira: Error
Closed record
Fields
- count? int -
- issueIdsOrKeys? string[] -
- message? string -
jira: ErrorCollection
Closed record
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 { string... } - 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? Signed32 -
jira: Errors
Closed record
Fields
- issueIsSubtask? Error -
- issuesInArchivedProjects? Error -
- issuesNotFound? Error -
- issuesInUnlicensedProjects? Error -
- userDoesNotHavePermission? Error -
jira: EvaluateJiraExpressionQueries
Represents the Queries record for the operation: evaluateJiraExpression
Fields
- expand? string - Use expand to include additional information in the response. This parameter accepts
meta.complexitythat returns information about the expression complexity. For example, the number of expensive operations used by the expression and how close the expression is to reaching the complexity limit. Useful when designing and debugging your expressions
jira: EvaluateJSISJiraExpressionQueries
Represents the Queries record for the operation: evaluateJSISJiraExpression
Fields
- expand? string - Use expand to include additional information in the response. This parameter accepts
meta.complexitythat returns information about the expression complexity. For example, the number of expensive operations used by the expression and how close the expression is to reaching the complexity limit. Useful when designing and debugging your expressions
jira: EventNotification
Closed record
Details about a notification associated with an event
Fields
- emailAddress? string - The email address
- expand? string - Expand options that include additional event notification details in the response
- 'field? FieldDetails - The custom user or group field
- projectRole? ProjectRole - The specified project role
- 'parameter? string - As a group's name can change, use of
recipientis recommended. The identifier associated with thenotificationTypevalue that defines the receiver of the notification, where the receiver isn't implied bynotificationTypevalue. So, whennotificationTypeis:UserTheparameteris the user account ID.GroupTheparameteris the group name.ProjectRoleTheparameteris the project role ID.UserCustomFieldTheparameteris the ID of the custom field.GroupCustomFieldTheparameteris the ID of the custom field
- recipient? string - The identifier associated with the
notificationTypevalue that defines the receiver of the notification, where the receiver isn't implied by thenotificationTypevalue. So, whennotificationTypeis:User,recipientis the user account ID.Group,recipientis the group ID.ProjectRole,recipientis the project role ID.UserCustomField,recipientis the ID of the custom field.GroupCustomField,recipientis the ID of the custom field
- id? int - The ID of the notification
- notificationType? "CurrentAssignee"|"Reporter"|"CurrentUser"|"ProjectLead"|"ComponentLead"|"User"|"Group"|"ProjectRole"|"EmailAddress"|"AllWatchers"|"UserCustomField"|"GroupCustomField" - Identifies the recipients of the notification
- user? UserDetails - The specified user
- group? GroupName - The specified group
jira: ExpandPrioritySchemePage
Fields
- maxResults? Signed32 -
- startAt? int -
- total? int -
jira: ExportArchivedIssuesTaskProgressResponse
Closed record
The response for status request for a running/completed export task
Fields
- payload? string -
- submittedTime? string -
- progress? int -
- fileUrl? string -
- taskId? string -
- status? string -
jira: FailedWebhook
Closed record
Details about a failed webhook
Fields
- failureTime int - The time the webhook was added to the list of failed webhooks (that is, the time of the last failed retry)
- id string - The webhook ID, as sent in the
X-Atlassian-Webhook-Identifierheader with the webhook
- body? string - The webhook body
- url string - The original webhook destination
jira: FailedWebhooks
Closed record
A page of failed webhooks
Fields
- 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)
- maxResults Signed32 - The maximum number of items on the page. If the list of values is shorter than this number, then there are no more pages
- values FailedWebhook[] - The list of webhooks
jira: Field
Closed record
Details of a field
Fields
- schema JsonTypeBean - The schema of a field
- stableId? string - The stable ID of the field
- searcherKey? string - The searcher key of the field. Returned for custom fields
- description? string - The description of the field
- isUnscreenable? boolean - Whether the field is shown on screen or not
- lastUsed? FieldLastUsed - Information about the most recent use of a field
- screensCount? int - Number of screens where the field is used
- contextsCount? int - Number of contexts where the field is used
- isLocked? boolean - Whether the field is locked
- name string - The name of the field
- id string - The ID of the field
- projectsCount? int - Number of projects where the field is used
- 'key? string - The key of the field
jira: FieldAssociationsRequest
Closed record
Details of field associations with projects
Fields
- associationContexts AssociationContextObject[] - Contexts to associate/unassociate the fields with
- fields FieldIdentifierObject[] - Fields to associate/unassociate with projects
jira: FieldCapabilityPayload
Closed record
Defines the payload for the fields, screens, screen schemes, issue type screen schemes, field layouts, and field layout schemes
Fields
- issueLayouts? IssueLayoutPayload[]? - The issue layouts configuration
- fieldLayoutScheme? FieldLayoutSchemePayload? - Defines the payload for the field layout schemes. See "Field Configuration Scheme" - https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations/#api-rest-api-3-fieldconfigurationscheme-post https://support.atlassian.com/jira-cloud-administration/docs/configure-a-field-configuration-scheme/
- screens? ScreenPayload[]? - The screens. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screens/#api-rest-api-3-screens-post
- customFieldDefinitions? CustomFieldPayload[]? - The custom field definitions. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields/#api-rest-api-3-field-post
- issueTypeScreenScheme? IssueTypeScreenSchemePayload? - Defines the payload for the issue type screen schemes. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-screen-schemes/#api-rest-api-3-issuetypescreenscheme-post
- screenScheme? ScreenSchemePayload[]? - The screen schemes See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-schemes/#api-rest-api-3-screenscheme-post
- fieldLayouts? FieldLayoutPayload[]? - The field layouts configuration
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
- predicates JqlQueryClauseTimePredicate[] - The list of time predicates
- 'field JqlQueryField - A field used in a JQL query. See Advanced searching - fields reference for more information about fields in JQL queries
- operator "changed" - The operator applied to the field
jira: FieldConfiguration
Closed record
Details of a field configuration
Fields
- isDefault? boolean - Whether the field configuration is the default
- name string - The name of the field configuration
- description string - The description of the field configuration
- id int - The ID of the field configuration
jira: FieldConfigurationDetails
Closed record
Details of a field configuration
Fields
- name string - The name of the field configuration. Must be unique
- description? string - The description of the field configuration
jira: FieldConfigurationIssueTypeItem
Closed record
The field configuration for an issue type
Fields
- 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
- fieldConfigurationSchemeId string - The ID of the field configuration scheme
- fieldConfigurationId string - The ID of the field configuration
jira: FieldConfigurationItem
Closed record
A field within a field configuration
Fields
- isRequired? boolean - Whether the field is required in the field configuration
- renderer? string - The renderer type for the field within the field configuration
- description? string - The description of the field within the field configuration
- id string - The ID of the field within the field configuration
- isHidden? boolean - Whether the field is hidden in the field configuration
jira: FieldConfigurationItemsDetails
Closed record
Details of field configuration items
Fields
- fieldConfigurationItems FieldConfigurationItem[] - Details of fields in a field configuration
jira: FieldConfigurationScheme
Closed record
Details of a field configuration scheme
Fields
- name string - The name of the field configuration scheme
- description? string - The description of the field configuration scheme
- id string - The ID of the field configuration scheme
jira: FieldConfigurationSchemeProjectAssociation
Closed record
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
Closed record
Project list with assigned field configuration schema
Fields
- projectIds string[] - The IDs of projects using the field configuration scheme
- fieldConfigurationScheme? FieldConfigurationScheme - Details of a field configuration scheme
jira: FieldConfigurationToIssueTypeMapping
Closed record
The field configuration to issue type mapping
Fields
- 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. An issue type can be included only once in a request
- fieldConfigurationId string - The ID of the field configuration
jira: FieldCreateMetadata
Closed record
The metadata describing an issue field for createmeta
Fields
- allowedValues? anydata[] - The list of values allowed in the field
- hasDefaultValue? boolean - Whether the field has a default value
- schema JsonTypeBean - The data type of the field
- operations string[] - The list of operations that can be performed on the field
- configuration? record {} - The configuration properties
- defaultValue? anydata - The default value of the field
- name string - The name of the field
- autoCompleteUrl? string - The URL that can be used to automatically complete the field
- 'key string - The key of the field
- required boolean - Whether the field is required
- fieldId string - The field id
jira: FieldDetails
Closed record
Details about a field
Fields
- schema? JsonTypeBean - The data schema for the field
- orderable? boolean - Whether the content of the field can be used to order lists
- custom? boolean - Whether the field is a custom field
- scope? Scope - The scope of the field
- name? string - The name of the field
- clauseNames? string[] - The names that can be used to reference the field in an advanced search. For more information, see Advanced searching - fields reference
- id? string - The ID of the field
- 'key? string - The key of the field
- searchable? boolean - Whether the content of the field can be searched
jira: FieldIdentifierObject
Closed record
Identifier for a field for example FIELD_ID
Fields
- identifier? record {} -
- 'type string -
jira: FieldLastUsed
Closed record
Information about the most recent use of a field
Fields
- 'type? "TRACKED"|"NOT_TRACKED"|"NO_INFORMATION" - 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: FieldLayoutConfiguration
Closed record
Defines the payload for the field layout configuration. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations/\#api-rest-api-3-fieldconfiguration-post
Fields
- 'field? boolean - Whether to show the field
- pcri? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
- required? boolean - Whether the field is required
jira: FieldLayoutPayload
Closed record
Defines the payload for the field layouts. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations/\#api-group-issue-field-configurations" + fieldlayout is what users would see as "Field Configuration" in Jira's UI - https://support.atlassian.com/jira-cloud-administration/docs/manage-issue-field-configurations/
Fields
- configuration? FieldLayoutConfiguration[] - The field layout configuration. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations/#api-rest-api-3-fieldconfiguration-post
- name? string - The name of the field layout
- description? string - The description of the field layout
- pcri? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
jira: FieldLayoutSchemePayload
Closed record
Defines the payload for the field layout schemes. See "Field Configuration Scheme" - https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations/\#api-rest-api-3-fieldconfigurationscheme-post https://support.atlassian.com/jira-cloud-administration/docs/configure-a-field-configuration-scheme/
Fields
- defaultFieldLayout? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
- name? string - The name of the field layout scheme
- description? string - The description of the field layout scheme
- pcri? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
- explicitMappings? record { ProjectCreateResourceIdentifier... } - There is a default configuration "fieldlayout" that is applied to all issue types using this scheme that don't have an explicit mapping users can create (or re-use existing) configurations for other issue types and map them to this scheme
jira: FieldMetadata
Closed record
The metadata describing an issue field
Fields
- allowedValues? anydata[] - The list of values allowed in the field
- hasDefaultValue? boolean - Whether the field has a default value
- schema JsonTypeBean - The data type of the field
- operations string[] - The list of operations that can be performed on the field
- configuration? record {} - The configuration properties
- defaultValue? anydata - The default value of the field
- name string - The name of the field
- autoCompleteUrl? string - The URL that can be used to automatically complete the field
- 'key string - The key of the field
- required boolean - Whether the field is required
jira: FieldReferenceData
Closed record
Details of a field that can be used in advanced searches
Fields
- cfid? string - If the item is a custom field, the ID of the custom field
- auto? "true"|"false" - Whether the field provide auto-complete suggestions
- types? string[] - The data types of items in the field
- operators? string[] - The valid search operators for the field
- displayName? string - The display name contains the following:
- for system fields, the field name. For example,
Summary. - for collapsed custom fields, the field name followed by a hyphen and then the field name and field type. For example,
Component - Component[Dropdown]. - for other custom fields, the field name followed by a hyphen and then the custom field ID. For example,
Component - cf[10061]
- for system fields, the field name. For example,
- orderable? "true"|"false" - Whether the field can be used in a query's
ORDER BYclause
- deprecated? "true"|"false" - Whether this field has been deprecated
- value? string - The field identifier
- deprecatedSearcherKey? string - The searcher key of the field, only passed when the field is deprecated
- searchable? "true"|"false" - Whether the content of this field can be searched
jira: Fields1
Closed record
Key fields from the linked issue
Fields
- issueType? IssueTypeDetails - The type of the linked issue
- summary? string - The summary description of the linked issue
- issuetype? IssueTypeDetails - Details about an issue type
- assignee? UserDetails - The assignee of the linked issue
- priority? Priority - The priority of the linked issue
- status? StatusDetails - The status of the linked issue
- timetracking? TimeTrackingDetails - The time tracking of the linked issue
jira: FieldUpdateOperation
Closed record
Details of an operation to perform on a field
Fields
- add? anydata - The value to add to the field
- set? anydata - The value to set in the field
- edit? anydata - The value to edit in the field
- copy? anydata - The field value to copy from another issue
- remove? anydata - The value to removed from the field
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
- operand JqlQueryClauseOperand - Details of an operand in a JQL clause
- operator "="|"!="|">"|"<"|">="|"<="|"in"|"not in"|"~"|"~="|"is"|"is not" - The operator between the field and operand
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
- predicates JqlQueryClauseTimePredicate[] - The list of time predicates
- 'field JqlQueryField - A field used in a JQL query. See Advanced searching - fields reference for more information about fields in JQL queries
- operand JqlQueryClauseOperand - Details of an operand in a JQL clause
- operator "was"|"was in"|"was not in"|"was not" - The operator between the field and operand
jira: Filter
Closed record
Details about a filter
Fields
- 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
- subscriptions? FilterSubscriptionsList - A paginated list of the users that are subscribed to the filter
- jql? string - The JQL query for the filter. For example, project = SSP AND issuetype = Bug
- favouritedCount? int - The count of how many users have selected this filter as a favorite, including the filter owner
- approximateLastUsed? string - [Experimental] Approximate last used time. Returns the date and time when the filter was last used. Returns
nullif the filter hasn't been used after tracking was enabled. For performance reasons, timestamps aren't updated in real time and therefore may not be exactly accurate
- description? string - A description of the filter
- favourite? boolean - Whether the filter is selected as a favorite
- editPermissions? SharePermission[] - The groups and projects that can edit the filter
- name string - The name of the filter. Must be unique
- 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
- self? string - The URL of the filter
- 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/3/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug
- id? string - The unique identifier for the filter
jira: FilterDetails
Closed record
Details of a filter
Fields
- owner? User - The user who owns the filter. Defaults to the creator of the filter, however, Jira administrators can change the owner of a shared filter in the admin settings
- subscriptions? FilterSubscription[] - The users that are subscribed to the filter
- jql? string - The JQL query for the filter. For example, project = SSP AND issuetype = Bug
- favouritedCount? int - The count of how many users have selected this filter as a favorite, including the filter owner
- approximateLastUsed? string - [Experimental] Approximate last used time. Returns the date and time when the filter was last used. Returns
nullif the filter hasn't been used after tracking was enabled. For performance reasons, timestamps aren't updated in real time and therefore may not be exactly accurate
- description? string - The description of the filter
- favourite? boolean - Whether the filter is selected as a favorite by any users, not including the filter owner
- expand? string - Expand options that include additional filter details in the response
- editPermissions? SharePermission[] - The groups and projects that can edit the filter. This can be specified when updating a filter, but not when creating a filter
- name string - The name of the filter
- 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
- self? string - The URL of the filter
- 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/3/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug
- id? string - The unique identifier for the filter
jira: FilterSubscription
Closed record
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
Closed record
A paginated list of subscriptions to a filter
Fields
- size? Signed32 - The number of items on the page
- endIndex? Signed32 - The index of the last item returned on the page
- maxResults? Signed32 - The maximum number of results that could be on the page
- startIndex? Signed32 - The index of the first item returned on the page
- items? FilterSubscription[] - The list of items
jira: FindAssignableUsersQueries
Represents the Queries record for the operation: findAssignableUsers
Fields
- accountId? string - A query string that is matched exactly against user
accountId. Required, unlessqueryis specified
- issueId? string - The ID of the issue. Required, unless
issueKeyorprojectis specified
- issueKey? string - The key of the issue. Required, unless
issueIdorprojectis specified
- maxResults Signed32(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
- query? string - A query string that is matched against user attributes, such as
displayName, andemailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with adisplayNameof John Smith and a user with anemailAddressof johnson@example.com. Required, unlessusernameoraccountIdis specified
- project? string - The project ID or project key (case sensitive). Required, unless
issueKeyorissueIdis specified
- recommend boolean(default false) -
- sessionId? string - The sessionId of this request. SessionId is the same until the assignee is set
- startAt Signed32(default 0) - The index of the first item to return in a page of results (page offset)
- actionDescriptorId? Signed32 - The ID of the transition
- username? string - This parameter is no longer available. See the deprecation notice for details
jira: FindBulkAssignableUsersQueries
Represents the Queries record for the operation: findBulkAssignableUsers
Fields
- accountId? string - A query string that is matched exactly against user
accountId. Required, unlessqueryis specified
- maxResults Signed32(default 50) - The maximum number of items to return per page
- query? string - A query string that is matched against user attributes, such as
displayNameandemailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with adisplayNameof John Smith and a user with anemailAddressof johnson@example.com. Required, unlessaccountIdis specified
- projectKeys string - A list of project keys (case sensitive). This parameter accepts a comma-separated list
- startAt Signed32(default 0) - The index of the first item to return in a page of results (page offset)
- username? string - This parameter is no longer available. See the deprecation notice for details
jira: FindComponentsForProjectsQueries
Represents the Queries record for the operation: findComponentsForProjects
Fields
- maxResults Signed32(default 50) - The maximum number of items to return per page
- query? string - Filter the results using a literal string. Components with a matching
nameordescriptionare returned (case insensitive)
- projectIdsOrKeys? string[] - The project IDs and/or project keys (case sensitive)
- orderBy? "description"|"-description"|"+description"|"name"|"-name"|"+name" - Order the results by a field:
descriptionSorts by the component description.nameSorts by component name
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: FindGroupsQueries
Represents the Queries record for the operation: findGroups
Fields
- accountId? string - This parameter is deprecated, setting it does not affect the results. To find groups containing a particular user, use Get user groups
- excludeId? string[] - A group ID to exclude from the result. To exclude multiple groups, provide an ampersand-separated list. For example,
excludeId=group1-id&excludeId=group2-id. This parameter cannot be used with theexcludeGroupsparameter
- maxResults? Signed32 - The maximum number of groups to return. The maximum number of groups that can be returned is limited by the system property
jira.ajax.autocomplete.limit
- query? string - The string to find in group names
- caseInsensitive boolean(default false) - Whether the search for groups should be case insensitive
- exclude? string[] - As a group's name can change, use of
excludeGroupIdsis recommended to identify a group.
A group to exclude from the result. To exclude multiple groups, provide an ampersand-separated list. For example,exclude=group1&exclude=group2. This parameter cannot be used with theexcludeGroupIdsparameter
- userName? string - This parameter is no longer available. See the deprecation notice for details
jira: FindUserKeysByQueryQueries
Represents the Queries record for the operation: findUserKeysByQuery
Fields
- maxResult Signed32(default 100) - The maximum number of items to return per page
- query string - The search query
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: FindUsersAndGroupsQueries
Represents the Queries record for the operation: findUsersAndGroups
Fields
- excludeConnectAddons boolean(default false) - Whether Connect app users and groups should be excluded from the search results. If an invalid value is provided, the default value is used
- issueTypeId? string[] - The ID of an issue type that returned users and groups must have permission to view. To include multiple issue types, provide an ampersand-separated list. For example,
issueTypeId=10000&issueTypeId=10001. Special values, such as-1(all standard issue types) and-2(all subtask issue types), are supported. This parameter is only used whenfieldIdis present
- maxResults Signed32(default 50) - The maximum number of items to return in each list
- query string - The search string
- caseInsensitive boolean(default false) - Whether the search for groups should be case insensitive
- showAvatar boolean(default false) - Whether the user avatar should be returned. If an invalid value is provided, the default value is used
- projectId? string[] - The ID of a project that returned users and groups must have permission to view. To include multiple projects, provide an ampersand-separated list. For example,
projectId=10000&projectId=10001. This parameter is only used whenfieldIdis present
- avatarSize "xsmall"|"xsmall@2x"|"xsmall@3x"|"small"|"small@2x"|"small@3x"|"medium"|"medium@2x"|"medium@3x"|"large"|"large@2x"|"large@3x"|"xlarge"|"xlarge@2x"|"xlarge@3x"|"xxlarge"|"xxlarge@2x"|"xxlarge@3x"|"xxxlarge"|"xxxlarge@2x"|"xxxlarge@3x" (default "xsmall") - The size of the avatar to return. If an invalid value is provided, the default value is used
- fieldId? string - The custom field ID of the field this request is for
jira: FindUsersByQueryQueries
Represents the Queries record for the operation: findUsersByQuery
Fields
- maxResults Signed32(default 100) - The maximum number of items to return per page
- query string - The search query
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: FindUsersForPickerQueries
Represents the Queries record for the operation: findUsersForPicker
Fields
- excludeAccountIds? string[] - A list of account IDs to exclude from the search results. This parameter accepts a comma-separated list. Multiple account IDs can also be provided using an ampersand-separated list. For example,
excludeAccountIds=5b10a2844c20165700ede21g,5b10a0effa615349cb016cd8&excludeAccountIds=5b10ac8d82e05b22cc7d4ef5. Cannot be provided withexclude
- maxResults Signed32(default 50) - The maximum number of items to return. The total number of matched users is returned in
total
- query string - A query string that is matched against user attributes, such as
displayName, andemailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with adisplayNameof John Smith and a user with anemailAddressof johnson@example.com
- exclude? string[] - This parameter is no longer available. See the deprecation notice for details
- showAvatar boolean(default false) - Include the URI to the user's avatar
- excludeConnectUsers boolean(default false) -
- avatarSize? string -
jira: FindUsersQueries
Represents the Queries record for the operation: findUsers
Fields
- accountId? string - A query string that is matched exactly against a user
accountId. Required, unlessqueryorpropertyis specified
- maxResults Signed32(default 50) - The maximum number of items to return per page
- query? string - A query string that is matched against user attributes (
displayName, andemailAddress) to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with adisplayNameof John Smith and a user with anemailAddressof johnson@example.com. Required, unlessaccountIdorpropertyis specified
- property? string - 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
nestedfrom{"something":{"nested":1,"other":2}}usethepropertykey.something.nested=1. Required, unlessaccountIdorqueryis specified
- startAt Signed32(default 0) - The index of the first item to return in a page of filtered results (page offset)
- username? string -
jira: FindUsersWithAllPermissionsQueries
Represents the Queries record for the operation: findUsersWithAllPermissions
Fields
- accountId? string - A query string that is matched exactly against user
accountId. Required, unlessqueryis specified
- projectKey? string - The project key for the project (case sensitive)
- issueKey? string - The issue key for the issue
- 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
- maxResults Signed32(default 50) - The maximum number of items to return per page
- query? string - A query string that is matched against user attributes, such as
displayNameandemailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with adisplayNameof John Smith and a user with anemailAddressof johnson@example.com. Required, unlessaccountIdis specified
- startAt Signed32(default 0) - The index of the first item to return in a page of results (page offset)
- username? string - This parameter is no longer available. See the deprecation notice for details
jira: FindUsersWithBrowsePermissionQueries
Represents the Queries record for the operation: findUsersWithBrowsePermission
Fields
- accountId? string - A query string that is matched exactly against user
accountId. Required, unlessqueryis specified
- projectKey? string - The project key for the project (case sensitive). Required, unless
issueKeyis specified
- issueKey? string - The issue key for the issue. Required, unless
projectKeyis specified
- maxResults Signed32(default 50) - The maximum number of items to return per page
- query? string - A query string that is matched against user attributes, such as
displayNameandemailAddress, to find relevant users. The string can match the prefix of the attribute's value. For example, query=john matches a user with adisplayNameof John Smith and a user with anemailAddressof johnson@example.com. Required, unlessaccountIdis specified
- startAt Signed32(default 0) - The index of the first item to return in a page of results (page offset)
- username? string - This parameter is no longer available. See the deprecation notice for details
jira: FoundGroup
Closed record
A group found in a search
Fields
- groupId? string - The ID of the group, which uniquely identifies the group across all Atlassian products. For example, 952d12c3-5b5b-4d04-bb32-44d383afc4b2
- name? string - The name of the group. The name of a group is mutable, to reliably identify a group use
groupId`.` MISSING[]
- html? string - The group name with the matched query string highlighted with the HTML bold tag
- labels? GroupLabel[] -
jira: FoundGroups
Closed record
The list of groups found in a search, including header text (Showing X of Y matching groups) and total of matched groups
Fields
- total? Signed32 - The total number of groups found in the search
- groups? FoundGroup[] -
- header? string - Header text indicating the number of groups in the response and the total number of groups found in the search
jira: FoundUsers
Closed record
The list of users found in a search, including header text (Showing X of Y matching users) and total of matched users
Fields
- total? Signed32 - The total number of users found in the search
- header? string - Header text indicating the number of users in the response and the total number of users found in the search
- users? UserPickerUser[] -
jira: FoundUsersAndGroups
Closed record
List of users and groups found in a search
Fields
- groups? FoundGroups - The list of groups found in a search, including header text (Showing X of Y matching groups) and total of matched groups
- users? FoundUsers - The list of users found in a search, including header text (Showing X of Y matching users) and total of matched users
jira: FromLayoutPayload
Closed record
The payload for the layout details for the start end of a transition
Fields
- fromPort? Signed32 - The port that the transition can be made from
- toPortOverride? Signed32 - The port that the transition goes to
- status? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
jira: FunctionOperand
An operand that is a function. See Advanced searching - functions reference for more information about JQL functions
Fields
- encodedOperand? string - Encoded operand, which can be used directly in a JQL query
- 'function string - The name of the function
- arguments string[] - The list of function arguments
jira: FunctionReferenceData
Closed record
Details of functions that can be used in advanced searches
Fields
- supportsListAndSingleValueOperators? "true"|"false" - Whether the function supports both single and list value operators
- types? string[] - The data types returned by the function
- displayName? string - The display name of the function
- isList? "true"|"false" - Whether the function can take a list of arguments
- value? string - The function identifier
jira: GetAllDashboardsQueries
Represents the Queries record for the operation: getAllDashboards
Fields
- filter? "my"|"favourite" - The filter applied to the list of dashboards. Valid values are:
favouriteReturns dashboards the user has marked as favorite.myReturns dashboards owned by the user
- maxResults Signed32(default 20) - The maximum number of items to return per page
- startAt Signed32(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetAllFieldConfigurationSchemesQueries
Represents the Queries record for the operation: getAllFieldConfigurationSchemes
Fields
- maxResults Signed32(default 50) - The maximum number of items to return per page
- id? int[] - The list of field configuration scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example,
id=10000&id=10001
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetAllFieldConfigurationsQueries
Represents the Queries record for the operation: getAllFieldConfigurations
Fields
- isDefault boolean(default false) - If true returns default field configurations only
- maxResults Signed32(default 50) - The maximum number of items to return per page
- query string(default "") - The query string used to match against field configuration names and descriptions
- id? int[] - The list of field configuration IDs. To include multiple IDs, provide an ampersand-separated list. For example,
id=10000&id=10001
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetAllGadgetsQueries
Represents the Queries record for the operation: getAllGadgets
Fields
- gadgetId? int[] - The list of gadgets IDs. To include multiple IDs, separate IDs with ampersand:
gadgetId=10000&gadgetId=10001
- uri? string[] - The list of gadgets URIs. To include multiple URIs, separate URIs with ampersand:
uri=/rest/example/uri/1&uri=/rest/example/uri/2
- moduleKey? string[] - The list of gadgets module keys. To include multiple module keys, separate module keys with ampersand:
moduleKey=key:one&moduleKey=key:two
jira: GetAllIssueFieldOptionsQueries
Represents the Queries record for the operation: getAllIssueFieldOptions
Fields
- maxResults Signed32(default 50) - The maximum number of items to return per page
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetAllIssueTypeSchemesQueries
Represents the Queries record for the operation: getAllIssueTypeSchemes
Fields
- expand string(default "") - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:
projectsFor each issue type schemes, returns information about the projects the issue type scheme is assigned to.issueTypesFor each issue type schemes, returns information about the issueTypes the issue type scheme have
- maxResults Signed32(default 50) - The maximum number of items to return per page
- orderBy "name"|"-name"|"+name"|"id"|"-id"|"+id" (default "id") - Order the results by a field:
nameSorts by issue type scheme name.idSorts by issue type scheme ID
- id? int[] - The list of issue type schemes IDs. To include multiple IDs, provide an ampersand-separated list. For example,
id=10000&id=10001
- queryString string(default "") - String used to perform a case-insensitive partial match with issue type scheme name
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetAllLabelsQueries
Represents the Queries record for the operation: getAllLabels
Fields
- maxResults Signed32(default 1000) - The maximum number of items to return per page
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetAllPermissionSchemesQueries
Represents the Queries record for the operation: getAllPermissionSchemes
Fields
- expand? string - 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:
allReturns all expandable information.fieldReturns information about the custom field granted the permission.groupReturns information about the group that is granted the permission.permissionsReturns all permission grants for each permission scheme.projectRoleReturns information about the project role granted the permission.userReturns information about the user who is granted the permission
jira: GetAllProjectsQueries
Represents the Queries record for the operation: getAllProjects
Fields
- expand? string - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include:
descriptionReturns the project description.issueTypesReturns all issue types associated with the project.leadReturns information about the project lead.projectKeysReturns all project keys associated with the project
- recent? Signed32 - 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[] - A list of project properties to return for the project. This parameter accepts a comma-separated list
jira: GetAllScreenTabFieldsQueries
Represents the Queries record for the operation: getAllScreenTabFields
Fields
- projectKey? string - The key of the project
jira: GetAllScreenTabsQueries
Represents the Queries record for the operation: getAllScreenTabs
Fields
- projectKey? string - The key of the project
jira: GetAllUserDataClassificationLevelsQueries
Represents the Queries record for the operation: getAllUserDataClassificationLevels
Fields
- orderBy? "rank"|"-rank"|"+rank" - Ordering of the results by a given field. If not provided, values will not be sorted
- status? ("PUBLISHED"|"ARCHIVED"|"DRAFT")[] - Optional set of statuses to filter by
jira: GetAllUsersDefaultQueries
Represents the Queries record for the operation: getAllUsersDefault
Fields
- maxResults Signed32(default 50) - The maximum number of items to return (limited to 1000)
- startAt Signed32(default 0) - The index of the first item to return
jira: GetAllUsersQueries
Represents the Queries record for the operation: getAllUsers
Fields
- maxResults Signed32(default 50) - The maximum number of items to return (limited to 1000)
- startAt Signed32(default 0) - The index of the first item to return
jira: GetAllWorkflowSchemesQueries
Represents the Queries record for the operation: getAllWorkflowSchemes
Fields
- maxResults Signed32(default 50) - The maximum number of items to return per page
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetAllWorkflowsQueries
Represents the Queries record for the operation: getAllWorkflows
Fields
- workflowName? string - The name of the workflow to be returned. Only one workflow can be specified
jira: GetApplicationPropertyQueries
Represents the Queries record for the operation: getApplicationProperty
Fields
- permissionLevel? string - The permission level of all items being returned in the list
- keyFilter? string - When a
keyisn't provided, this filters the list of results by the application propertykeyusing a regular expression. For example, usingjira.lf.*will return all application properties with keys that start with jira.lf.
- 'key? string - The key of the application property
jira: GetAssignedPermissionSchemeQueries
Represents the Queries record for the operation: getAssignedPermissionScheme
Fields
- expand? string - 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:
allReturns all expandable information.fieldReturns information about the custom field granted the permission.groupReturns information about the group that is granted the permission.permissionsReturns all permission grants for each permission scheme.projectRoleReturns information about the project role granted the permission.userReturns information about the user who is granted the permission
jira: GetAtlassianTeamResponse
Closed record
Fields
- planningStyle "Scrum"|"Kanban" - The planning style for the Atlassian team. This is "Scrum" or "Kanban"
- issueSourceId? int - The ID of the issue source for the Atlassian team
- sprintLength? int - The sprint length for the Atlassian team
- id string - The Atlassian team ID
- capacity? decimal - The capacity for the Atlassian team
jira: GetAttachmentContentQueries
Represents the Queries record for the operation: getAttachmentContent
Fields
- redirect boolean(default true) - Whether a redirect is provided for the attachment download. Clients that do not automatically follow redirects can set this to
falseto avoid making multiple requests to download the attachment
jira: GetAttachmentThumbnailQueries
Represents the Queries record for the operation: getAttachmentThumbnail
Fields
- redirect boolean(default true) - Whether a redirect is provided for the attachment download. Clients that do not automatically follow redirects can set this to
falseto avoid making multiple requests to download the attachment
- fallbackToDefault boolean(default true) - Whether a default thumbnail is returned when the requested thumbnail is not found
- width? Signed32 - The maximum width to scale the thumbnail to
- height? Signed32 - The maximum height to scale the thumbnail to
jira: GetAuditRecordsQueries
Represents the Queries record for the operation: getAuditRecords
Fields
- filter? string - The strings to match with audit field content, space separated
- offset Signed32(default 0) - The number of records to skip before returning the first result
- 'limit Signed32(default 1000) - The maximum number of results to return
- 'from? string - The date and time on or after which returned audit records must have been created. If
tois providedfrommust be beforetoor no audit records are returned
- to? string - The date and time on or before which returned audit results must have been created. If
fromis providedtomust be afterfromor no audit records are returned
jira: GetAvailablePrioritiesByPrioritySchemeQueries
Represents the Queries record for the operation: getAvailablePrioritiesByPriorityScheme
Fields
- maxResults string(default "50") - The maximum number of items to return per page
- query string(default "") - The string to query priorities on by name
- schemeId string - The priority scheme ID
- exclude? string[] - A list of priority IDs to exclude from the results
- startAt string(default "0") - The index of the first item to return in a page of results (page offset)
jira: GetAvailableTransitionsQueries
Represents the Queries record for the operation: getAvailableTransitions
Fields
- startingAfter? string - (Optional)The start cursor for use in pagination
- issueIdsOrKeys string - Comma (,) separated Ids or keys of the issues to get transitions available for them
- endingBefore? string - (Optional)The end cursor for use in pagination
jira: GetAvatarImageByIDQueries
Represents the Queries record for the operation: getAvatarImageByID
Fields
- size? "xsmall"|"small"|"medium"|"large"|"xlarge" - The size of the avatar image. If not provided the default size is returned
- format? "png"|"svg" - The format to return the avatar image in. If not provided the original content format is returned
jira: GetAvatarImageByOwnerQueries
Represents the Queries record for the operation: getAvatarImageByOwner
Fields
- size? "xsmall"|"small"|"medium"|"large"|"xlarge" - The size of the avatar image. If not provided the default size is returned
- format? "png"|"svg" - The format to return the avatar image in. If not provided the original content format is returned
jira: GetAvatarImageByTypeQueries
Represents the Queries record for the operation: getAvatarImageByType
Fields
- size? "xsmall"|"small"|"medium"|"large"|"xlarge" - The size of the avatar image. If not provided the default size is returned
- format? "png"|"svg" - The format to return the avatar image in. If not provided the original content format is returned
jira: GetBulkEditableFieldsQueries
Represents the Queries record for the operation: getBulkEditableFields
Fields
- searchText? string - (Optional)The text to search for in the editable fields
- startingAfter? string - (Optional)The start cursor for use in pagination
- issueIdsOrKeys string - The IDs or keys of the issues to get editable fields from
- endingBefore? string - (Optional)The end cursor for use in pagination
jira: GetBulkScreenTabsQueries
Represents the Queries record for the operation: getBulkScreenTabs
Fields
- screenId? int[] - The list of screen IDs. To include multiple screen IDs, provide an ampersand-separated list. For example,
screenId=10000&screenId=10001
- tabId? int[] - The list of tab IDs. To include multiple tab IDs, provide an ampersand-separated list. For example,
tabId=10000&tabId=10001
- maxResult Signed32(default 100) - The maximum number of items to return per page. The maximum number is 100,
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetChangeLogsQueries
Represents the Queries record for the operation: getChangeLogs
Fields
- maxResults Signed32(default 100) - The maximum number of items to return per page
- startAt Signed32(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetCommentQueries
Represents the Queries record for the operation: getComment
Fields
jira: GetCommentsByIdsQueries
Represents the Queries record for the operation: getCommentsByIds
Fields
jira: GetCommentsQueries
Represents the Queries record for the operation: getComments
Fields
- maxResults Signed32(default 100) - The maximum number of items to return per page
- orderBy? "created"|"-created"|"+created" - Order the results by a field. Accepts created to sort comments by their created date
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetContextsForFieldDeprecatedQueries
Represents the Queries record for the operation: getContextsForFieldDeprecated
Fields
- maxResults Signed32(default 20) - The maximum number of items to return per page
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetContextsForFieldQueries
Represents the Queries record for the operation: getContextsForField
Fields
- maxResults Signed32(default 50) - The maximum number of items to return per page
- contextId? int[] - The list of context IDs. To include multiple contexts, separate IDs with ampersand:
contextId=10000&contextId=10001
- isAnyIssueType? boolean - Whether to return contexts that apply to all issue types
- isGlobalContext? boolean - Whether to return contexts that apply to all projects
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetCreateIssueMetaIssueTypeIdQueries
Represents the Queries record for the operation: getCreateIssueMetaIssueTypeId
Fields
- maxResults Signed32(default 50) - The maximum number of items to return per page
- startAt Signed32(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetCreateIssueMetaIssueTypesQueries
Represents the Queries record for the operation: getCreateIssueMetaIssueTypes
Fields
- maxResults Signed32(default 50) - The maximum number of items to return per page
- startAt Signed32(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetCreateIssueMetaQueries
Represents the Queries record for the operation: getCreateIssueMeta
Fields
- expand? string - 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 thefieldsandupdatefields in Create issue and Create issues
- issuetypeNames? string[] - List of issue type names. This parameter accepts a comma-separated list. Multiple issue type names can also be provided using an ampersand-separated list. For example,
issuetypeNames=name1,name2&issuetypeNames=name3. This parameter may be provided withissuetypeIds
- projectIds? string[] - List of project IDs. This parameter accepts a comma-separated list. Multiple project IDs can also be provided using an ampersand-separated list. For example,
projectIds=10000,10001&projectIds=10020,10021. This parameter may be provided withprojectKeys
- projectKeys? string[] - List of project keys. This parameter accepts a comma-separated list. Multiple project keys can also be provided using an ampersand-separated list. For example,
projectKeys=proj1,proj2&projectKeys=proj3. This parameter may be provided withprojectIds
- issuetypeIds? string[] - List of issue type IDs. This parameter accepts a comma-separated list. Multiple issue type IDs can also be provided using an ampersand-separated list. For example,
issuetypeIds=10000,10001&issuetypeIds=10020,10021. This parameter may be provided withissuetypeNames
jira: GetCrossProjectReleaseResponse
Closed record
Fields
- releaseIds? int[] - The IDs of the releases included in the cross-project release
- name? string - The cross-project release name
jira: GetCurrentUserQueries
Represents the Queries record for the operation: getCurrentUser
Fields
- expand? string - Use expand to include additional information about user in the response. This parameter accepts a comma-separated list. Expand options include:
groupsReturns all groups, including nested groups, the user belongs to.applicationRolesReturns the application roles the user is assigned to
jira: GetCustomFieldConfigurationQueries
Represents the Queries record for the operation: getCustomFieldConfiguration
Fields
- fieldContextId? int[] - The list of field context IDs. To include multiple field contexts, separate IDs with an ampersand:
fieldContextId=10000&fieldContextId=10001. Can't be provided withid,issueId,projectKeyOrId, orissueTypeId
- issueId? int - The ID of the issue to filter results by. If the issue doesn't exist, an empty list is returned. Can't be provided with
projectKeyOrId, orissueTypeId
- issueTypeId? string - The ID of the issue type to filter results by. Must be provided with
projectKeyOrId. Can't be provided withissueId
- maxResults Signed32(default 100) - The maximum number of items to return per page
- projectKeyOrId? string - The ID or key of the project to filter results by. Must be provided with
issueTypeId. Can't be provided withissueId
- id? int[] - The list of configuration IDs. To include multiple configurations, separate IDs with an ampersand:
id=10000&id=10001. Can't be provided withfieldContextId,issueId,projectKeyOrId, orissueTypeId
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetCustomFieldContextsForProjectsAndIssueTypesQueries
Represents the Queries record for the operation: getCustomFieldContextsForProjectsAndIssueTypes
Fields
- maxResults Signed32(default 50) - The maximum number of items to return per page
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetCustomFieldResponse
Closed record
Fields
- filter? boolean - Allows filtering issues based on their values for the custom field
- customFieldId int - The custom field ID
jira: GetCustomFieldsConfigurationsQueries
Represents the Queries record for the operation: getCustomFieldsConfigurations
Fields
- fieldContextId? int[] - The list of field context IDs. To include multiple field contexts, separate IDs with an ampersand:
fieldContextId=10000&fieldContextId=10001. Can't be provided withid,issueId,projectKeyOrId, orissueTypeId
- issueId? int - The ID of the issue to filter results by. If the issue doesn't exist, an empty list is returned. Can't be provided with
projectKeyOrId, orissueTypeId
- issueTypeId? string - The ID of the issue type to filter results by. Must be provided with
projectKeyOrId. Can't be provided withissueId
- maxResults Signed32(default 100) - The maximum number of items to return per page
- projectKeyOrId? string - The ID or key of the project to filter results by. Must be provided with
issueTypeId. Can't be provided withissueId
- id? int[] - The list of configuration IDs. To include multiple configurations, separate IDs with an ampersand:
id=10000&id=10001. Can't be provided withfieldContextId,issueId,projectKeyOrId, orissueTypeId
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetDashboardsPaginatedQueries
Represents the Queries record for the operation: getDashboardsPaginated
Fields
- owner? string - This parameter is deprecated because of privacy changes. Use
accountIdinstead. See the migration guide for details. User name used to return dashboards with the matchingowner.name. This parameter cannot be used with theaccountIdparameter
- accountId? string - User account ID used to return dashboards with the matching
owner.accountId. This parameter cannot be used with theownerparameter
- expand? string - Use expand to include additional information about dashboard in the response. This parameter accepts a comma-separated list. Expand options include:
descriptionReturns the description of the dashboard.ownerReturns the owner of the dashboard.viewUrlReturns the URL that is used to view the dashboard.favouriteReturnsisFavourite, an indicator of whether the user has set the dashboard as a favorite.favouritedCountReturnspopularity, a count of how many users have set this dashboard as a favorite.sharePermissionsReturns details of the share permissions defined for the dashboard.editPermissionsReturns details of the edit permissions defined for the dashboard.isWritableReturns whether the current user has permission to edit the dashboard
- maxResults Signed32(default 50) - The maximum number of items to return per page
- groupId? string - Group ID used to return dashboards that are shared with a group that matches
sharePermissions.group.groupId. This parameter cannot be used with thegroupnameparameter
- orderBy "description"|"-description"|"+description"|"favorite_count"|"-favorite_count"|"+favorite_count"|"id"|"-id"|"+id"|"is_favorite"|"-is_favorite"|"+is_favorite"|"name"|"-name"|"+name"|"owner"|"-owner"|"+owner" (default "name") - Order the results by a field:
descriptionSorts by dashboard description. Note that this sort works independently of whether the expand to display the description field is in use.favourite_countSorts by dashboard popularity.idSorts by dashboard ID.is_favouriteSorts by whether the dashboard is marked as a favorite.nameSorts by dashboard name.ownerSorts by dashboard owner name
- groupname? string - As a group's name can change, use of
groupIdis recommended. Group name used to return dashboards that are shared with a group that matchessharePermissions.group.name. This parameter cannot be used with thegroupIdparameter
- projectId? int - Project ID used to returns dashboards that are shared with a project that matches
sharePermissions.project.id
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
- dashboardName? string - String used to perform a case-insensitive partial match with
name
- status "active"|"archived"|"deleted" (default "active") - The status to filter by. It may be active, archived or deleted
jira: GetDateFieldResponse
Closed record
Fields
- dateCustomFieldId? int - A date custom field ID. This is returned if the type is "DateCustomField"
- 'type "DueDate"|"TargetStartDate"|"TargetEndDate"|"DateCustomField" - The date field type. This is "DueDate", "TargetStartDate", "TargetEndDate" or "DateCustomField"
jira: GetDefaultValuesQueries
Represents the Queries record for the operation: getDefaultValues
Fields
- maxResults Signed32(default 50) - The maximum number of items to return per page
- contextId? int[] - The IDs of the contexts
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetDefaultWorkflowQueries
Represents the Queries record for the operation: getDefaultWorkflow
Fields
- returnDraftIfExists boolean(default false) - Set to
trueto 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
jira: GetDraftWorkflowQueries
Represents the Queries record for the operation: getDraftWorkflow
Fields
- workflowName? string - The name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow
jira: GetDynamicWebhooksForAppQueries
Represents the Queries record for the operation: getDynamicWebhooksForApp
Fields
- maxResults Signed32(default 100) - The maximum number of items to return per page
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetEditIssueMetaQueries
Represents the Queries record for the operation: getEditIssueMeta
Fields
- overrideScreenSecurity boolean(default false) - Whether hidden fields are returned. Available to Connect app users with Administer Jira global permission and Forge apps acting on behalf of users with Administer Jira global permission
- overrideEditableFlag boolean(default false) - Whether non-editable fields are returned. Available to Connect app users with Administer Jira global permission and Forge apps acting on behalf of users with Administer Jira global permission
jira: GetExclusionRulesResponse
Closed record
Fields
- workStatusIds? int[] - The IDs of the work statuses excluded from the plan
- releaseIds? int[] - The IDs of the releases excluded from the plan
- numberOfDaysToShowCompletedIssues Signed32 - Issues completed this number of days ago are excluded from the plan
- issueTypeIds? int[] - The IDs of the issue types excluded from the plan
- workStatusCategoryIds? int[] - The IDs of the work status categories excluded from the plan
- issueIds? int[] - The IDs of the issues excluded from the plan
jira: GetFailedWebhooksQueries
Represents the Queries record for the operation: getFailedWebhooks
Fields
- maxResults? Signed32 - The maximum number of webhooks to return per page. If obeying the maxResults directive would result in records with the same failure time being split across pages, the directive is ignored and all records with the same failure time included on the page
- after? int - The time after which any webhook failure must have occurred for the record to be returned, expressed as milliseconds since the UNIX epoch
jira: GetFavouriteFiltersQueries
Represents the Queries record for the operation: getFavouriteFilters
Fields
- expand? string - Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:
sharedUsersReturns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specifysharedUsers, then thesharedUsersobject is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append[start-index:end-index]to the expand request. For example, to access the next 1000 users, use?expand=sharedUsers[1001:2000].subscriptionsReturns the users that are subscribed to the filter. If you don't specifysubscriptions, thesubscriptionsobject is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append[start-index:end-index]to the expand request. For example, to access the next 1000 subscriptions, use?expand=subscriptions[1001:2000]
jira: GetFieldAutoCompleteForQueryStringQueries
Represents the Queries record for the operation: getFieldAutoCompleteForQueryString
Fields
- predicateValue? string - The partial predicate item name entered by the user
- fieldName? string - The name of the field
- predicateName? string - The name of the CHANGED operator predicate for which the suggestions are generated. The valid predicate operators are by, from, and to
- fieldValue? string - The partial field item name entered by the user
jira: GetFieldConfigurationItemsQueries
Represents the Queries record for the operation: getFieldConfigurationItems
Fields
- maxResults Signed32(default 50) - The maximum number of items to return per page
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetFieldConfigurationSchemeMappingsQueries
Represents the Queries record for the operation: getFieldConfigurationSchemeMappings
Fields
- maxResults Signed32(default 50) - The maximum number of items to return per page
- fieldConfigurationSchemeId? int[] - The list of field configuration scheme IDs. To include multiple field configuration schemes separate IDs with ampersand:
fieldConfigurationSchemeId=10000&fieldConfigurationSchemeId=10001
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetFieldConfigurationSchemeProjectMappingQueries
Represents the Queries record for the operation: getFieldConfigurationSchemeProjectMapping
Fields
- maxResults Signed32(default 50) - The maximum number of items to return per page
- 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)
jira: GetFieldsPaginatedQueries
Represents the Queries record for the operation: getFieldsPaginated
Fields
- expand? string - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:
keyreturns the key for each fieldstableIdreturns the stableId for each fieldlastUsedreturns the date when the value of the field last changedscreensCountreturns the number of screens related to a fieldcontextsCountreturns the number of contexts related to a fieldisLockedreturns information about whether the field is lockedsearcherKeyreturns the searcher key for each custom field
- maxResults Signed32(default 50) - The maximum number of items to return per page
- query? string - String used to perform a case-insensitive partial match with field names or descriptions
- orderBy? "contextsCount"|"-contextsCount"|"+contextsCount"|"lastUsed"|"-lastUsed"|"+lastUsed"|"name"|"-name"|"+name"|"screensCount"|"-screensCount"|"+screensCount"|"projectsCount"|"-projectsCount"|"+projectsCount" - Order the results by:
contextsCountsorts by the number of contexts related to a fieldlastUsedsorts by the date when the value of the field last changednamesorts by the field namescreensCountsorts by the number of screens related to a field
- id? string[] - The IDs of the custom fields to return or, where
queryis specified, filter
- projectIds? int[] - The IDs of the projects to filter the fields by. Fields belonging to project Ids that the user does not have access to will not be returned
- 'type? ("custom"|"system")[] - The type of fields to search
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetFilterQueries
Represents the Queries record for the operation: getFilter
Fields
- expand? string - Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:
sharedUsersReturns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specifysharedUsers, then thesharedUsersobject is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append[start-index:end-index]to the expand request. For example, to access the next 1000 users, use?expand=sharedUsers[1001:2000].subscriptionsReturns the users that are subscribed to the filter. If you don't specifysubscriptions, thesubscriptionsobject is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append[start-index:end-index]to the expand request. For example, to access the next 1000 subscriptions, use?expand=subscriptions[1001:2000]
jira: GetFiltersPaginatedQueries
Represents the Queries record for the operation: getFiltersPaginated
Fields
- owner? string - This parameter is deprecated because of privacy changes. Use
accountIdinstead. See the migration guide for details. User name used to return filters with the matchingowner.name. This parameter cannot be used withaccountId
- groupId? string - Group ID used to returns filters that are shared with a group that matches
sharePermissions.group.groupId. This parameter cannot be used with thegroupnameparameter
- filterName? string - String used to perform a case-insensitive partial match with
name
- orderBy "description"|"-description"|"+description"|"favourite_count"|"-favourite_count"|"+favourite_count"|"id"|"-id"|"+id"|"is_favourite"|"-is_favourite"|"+is_favourite"|"name"|"-name"|"+name"|"owner"|"-owner"|"+owner"|"is_shared"|"-is_shared"|"+is_shared" (default "name") - Order the results by a field:
descriptionSorts by filter description. Note that this sorting works independently of whether the expand to display the description field is in use.favourite_countSorts by the count of how many users have this filter as a favorite.is_favouriteSorts by whether the filter is marked as a favorite.idSorts by filter ID.nameSorts by filter name.ownerSorts by the ID of the filter owner.is_sharedSorts by whether the filter is shared
- groupname? string - As a group's name can change, use of
groupIdis recommended to identify a group. Group name used to returns filters that are shared with a group that matchessharePermissions.group.groupname. This parameter cannot be used with thegroupIdparameter
- accountId? string - User account ID used to return filters with the matching
owner.accountId. This parameter cannot be used withowner
- expand? string - Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:
descriptionReturns the description of the filter.favouriteReturns an indicator of whether the user has set the filter as a favorite.favouritedCountReturns a count of how many users have set this filter as a favorite.jqlReturns the JQL query that the filter uses.ownerReturns the owner of the filter.searchUrlReturns a URL to perform the filter's JQL query.sharePermissionsReturns the share permissions defined for the filter.editPermissionsReturns the edit permissions defined for the filter.isWritableReturns whether the current user has permission to edit the filter.approximateLastUsed[Experimental] Returns the approximate date and time when the filter was last evaluated.subscriptionsReturns the users that are subscribed to the filter.viewUrlReturns a URL to view the filter
- maxResults Signed32(default 50) - The maximum number of items to return per page
- isSubstringMatch boolean(default false) - When
truethis will perform a case-insensitive substring match for the providedfilterName. Whenfalsethe filter name will be searched using full text search syntax
- id? int[] - The list of filter IDs. To include multiple IDs, provide an ampersand-separated list. For example,
id=10000&id=10001. Do not exceed 200 filter IDs
- projectId? int - Project ID used to returns filters that are shared with a project that matches
sharePermissions.project.id
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetGroupQueries
Represents the Queries record for the operation: getGroup
Fields
- expand? string - List of fields to expand
- groupId? string - The ID of the group. This parameter cannot be used with the
groupNameparameter
- groupname? string - As a group's name can change, use of
groupIdis recommended to identify a group.
The name of the group. This parameter cannot be used with thegroupIdparameter
jira: GetIdsOfWorklogsDeletedSinceQueries
Represents the Queries record for the operation: getIdsOfWorklogsDeletedSince
Fields
- since int(default 0) - The date and time, as a UNIX timestamp in milliseconds, after which deleted worklogs are returned
jira: GetIdsOfWorklogsModifiedSinceQueries
Represents the Queries record for the operation: getIdsOfWorklogsModifiedSince
Fields
- since int(default 0) - The date and time, as a UNIX timestamp in milliseconds, after which updated worklogs are returned
jira: GetIssueLimitReportQueries
Represents the Queries record for the operation: getIssueLimitReport
Fields
- isReturningKeys boolean(default false) - Return issue keys instead of issue ids in the response.
Usage: Add
?isReturningKeys=trueto the end of the path to request issue keys
jira: GetIssuePickerResourceQueries
Represents the Queries record for the operation: getIssuePickerResource
Fields
- currentProjectId? string - The ID of a project that suggested issues must belong to
- query? string - A string to match against text fields in the issue such as title, description, or comments
- currentIssueKey? string - The key of an issue to exclude from search results. For example, the issue the user is viewing when they perform this query
- currentJQL? string - A JQL query defining a list of issues to search for the query term. Note that
usernameanduserkeycannot be used as search terms for this parameter, due to privacy reasons. UseaccountIdinstead
- showSubTasks? boolean - Indicate whether to include subtasks in the suggestions list
- showSubTaskParent? boolean - When
currentIssueKeyis a subtask, whether to include the parent issue in the suggestions if it matches the query
jira: GetIssueQueries
Represents the Queries record for the operation: getIssue
Fields
- expand? string - Use expand to include additional information about the issues in the response. This parameter accepts a comma-separated list. Expand options include:
renderedFieldsReturns field values rendered in HTML format.namesReturns the display name of each field.schemaReturns the schema describing a field type.transitionsReturns all possible transitions for the issue.editmetaReturns information about how each field can be edited.changelogReturns a list of recent updates to an issue, sorted by date, starting from the most recent.versionedRepresentationsReturns 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, thefieldsparameter is ignored
- fieldsByKeys boolean(default false) - Whether fields in
fieldsare 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
- fields? string[] - 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:
*allReturns all fields.*navigableReturns navigable fields.- Any issue field, prefixed with a minus to exclude.
summary,commentReturns only the summary and comments fields.-descriptionReturns all (default) fields except description.*navigable,-commentReturns all navigable fields except comment.
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
- properties? string[] - A list of issue properties to return for the issue. This parameter accepts a comma-separated list. Allowed values:
*allReturns all issue properties.- Any issue property key, prefixed with a minus to exclude.
*allReturns all properties.*all,-prop1Returns all properties exceptprop1.prop1,prop2Returnsprop1andprop2properties.
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
lastViewedfield
- failFast boolean(default false) - Whether to fail the request quickly in case of an error while loading fields for an issue. For
failFast=true, if one field fails, the entire operation fails. ForfailFast=false, the operation will continue even if a field fails. It will return a valid response, but without values for the failed field(s)
jira: GetIssueSecurityLevelMembersQueries
Represents the Queries record for the operation: getIssueSecurityLevelMembers
Fields
- expand? string - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:
allReturns all expandable information.fieldReturns information about the custom field granted the permission.groupReturns information about the group that is granted the permission.projectRoleReturns information about the project role granted the permission.userReturns information about the user who is granted the permission
- maxResults Signed32(default 50) - The maximum number of items to return per page
- issueSecurityLevelId? string[] - The list of issue security level IDs. To include multiple issue security levels separate IDs with ampersand:
issueSecurityLevelId=10000&issueSecurityLevelId=10001
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetIssueSourceResponse
Closed record
Fields
- 'type "Board"|"Project"|"Filter"|"Custom" - The issue source type. This is "Board", "Project" or "Filter"
- value int - The issue source value. This is a board ID if the type is "Board", a project ID if the type is "Project" or a filter ID if the type is "Filter"
jira: GetIssueTypeMappingsForContextsQueries
Represents the Queries record for the operation: getIssueTypeMappingsForContexts
Fields
- maxResults Signed32(default 50) - The maximum number of items to return per page
- contextId? int[] - 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)
jira: GetIssueTypeSchemeForProjectsQueries
Represents the Queries record for the operation: getIssueTypeSchemeForProjects
Fields
- maxResults Signed32(default 50) - The maximum number of items to return per page
- projectId int[] - The list of project IDs. To include multiple project IDs, provide an ampersand-separated list. For example,
projectId=10000&projectId=10001
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetIssueTypeSchemesMappingQueries
Represents the Queries record for the operation: getIssueTypeSchemesMapping
Fields
- maxResults Signed32(default 50) - The maximum number of items to return per page
- issueTypeSchemeId? int[] - The list of issue type scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example,
issueTypeSchemeId=10000&issueTypeSchemeId=10001
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetIssueTypeScreenSchemeMappingsQueries
Represents the Queries record for the operation: getIssueTypeScreenSchemeMappings
Fields
- issueTypeScreenSchemeId? int[] - The list of issue type screen scheme IDs. To include multiple issue type screen schemes, separate IDs with ampersand:
issueTypeScreenSchemeId=10000&issueTypeScreenSchemeId=10001
- maxResults Signed32(default 50) - The maximum number of items to return per page
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetIssueTypeScreenSchemeProjectAssociationsQueries
Represents the Queries record for the operation: getIssueTypeScreenSchemeProjectAssociations
Fields
- maxResults Signed32(default 50) - The maximum number of items to return per page
- 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)
jira: GetIssueTypeScreenSchemesQueries
Represents the Queries record for the operation: getIssueTypeScreenSchemes
Fields
- maxResults Signed32(default 50) - The maximum number of items to return per page
- orderBy "name"|"-name"|"+name"|"id"|"-id"|"+id" (default "id") - Order the results by a field:
nameSorts by issue type screen scheme name.idSorts by issue type screen scheme ID
- id? int[] - The list of issue type screen scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example,
id=10000&id=10001
- queryString string(default "") - String used to perform a case-insensitive partial match with issue type screen scheme name
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetIssueTypesForProjectQueries
Represents the Queries record for the operation: getIssueTypesForProject
Fields
- level? Signed32 - The level of the issue type to filter by. Use:
-1for Subtask.0for Base.1for Epic
- projectId int - The ID of the project
jira: GetIssueWorklogQueries
Represents the Queries record for the operation: getIssueWorklog
Fields
- maxResults Signed32(default 5000) - The maximum number of items to return per page
- startedAfter? int - The worklog start date and time, as a UNIX timestamp in milliseconds, after which worklogs are returned
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
- startedBefore? int - The worklog start date and time, as a UNIX timestamp in milliseconds, before which worklogs are returned
jira: GetMyFiltersQueries
Represents the Queries record for the operation: getMyFilters
Fields
- expand? string - Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:
sharedUsersReturns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specifysharedUsers, then thesharedUsersobject is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append[start-index:end-index]to the expand request. For example, to access the next 1000 users, use?expand=sharedUsers[1001:2000].subscriptionsReturns the users that are subscribed to the filter. If you don't specifysubscriptions, thesubscriptionsobject is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append[start-index:end-index]to the expand request. For example, to access the next 1000 subscriptions, use?expand=subscriptions[1001:2000]
- includeFavourites boolean(default false) - Include the user's favorite filters in the response
jira: GetMyPermissionsQueries
Represents the Queries record for the operation: getMyPermissions
Fields
- projectKey? string - The key of project. Ignored if
projectIdis provided
- issueId? string - The ID of the issue
- issueKey? string - The key of the issue. Ignored if
issueIdis provided
- permissions? string - A list of permission keys. (Required) This parameter accepts a comma-separated list. To get the list of available permissions, use Get all permissions
- projectConfigurationUuid? string -
- commentId? string - The ID of the comment
- projectId? string - The ID of project
- projectUuid? string -
jira: GetNotificationSchemeForProjectQueries
Represents the Queries record for the operation: getNotificationSchemeForProject
Fields
- expand? string - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:
allReturns all expandable informationfieldReturns information about any custom fields assigned to receive an eventgroupReturns information about any groups assigned to receive an eventnotificationSchemeEventsReturns a list of event associations. This list is returned for all expandable informationprojectRoleReturns information about any project roles assigned to receive an eventuserReturns information about any users assigned to receive an event
jira: GetNotificationSchemeQueries
Represents the Queries record for the operation: getNotificationScheme
Fields
- expand? string - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:
allReturns all expandable informationfieldReturns information about any custom fields assigned to receive an eventgroupReturns information about any groups assigned to receive an eventnotificationSchemeEventsReturns a list of event associations. This list is returned for all expandable informationprojectRoleReturns information about any project roles assigned to receive an eventuserReturns information about any users assigned to receive an event
jira: GetNotificationSchemesQueries
Represents the Queries record for the operation: getNotificationSchemes
Fields
- expand? string - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:
allReturns all expandable informationfieldReturns information about any custom fields assigned to receive an eventgroupReturns information about any groups assigned to receive an eventnotificationSchemeEventsReturns a list of event associations. This list is returned for all expandable informationprojectRoleReturns information about any project roles assigned to receive an eventuserReturns information about any users assigned to receive an event
- onlyDefault boolean(default false) - When set to true, returns only the default notification scheme. If you provide project IDs not associated with the default, returns an empty page. The default value is false
- maxResults string(default "50") - The maximum number of items to return per page
- id? string[] - The list of notification schemes IDs to be filtered by
- projectId? string[] - The list of projects IDs to be filtered by
- startAt string(default "0") - The index of the first item to return in a page of results (page offset)
jira: GetNotificationSchemeToProjectMappingsQueries
Represents the Queries record for the operation: getNotificationSchemeToProjectMappings
Fields
- notificationSchemeId? string[] - The list of notifications scheme IDs to be filtered out
- maxResults string(default "50") - The maximum number of items to return per page
- projectId? string[] - The list of project IDs to be filtered out
- startAt string(default "0") - The index of the first item to return in a page of results (page offset)
jira: GetOptionsForContextQueries
Represents the Queries record for the operation: getOptionsForContext
Fields
- onlyOptions boolean(default false) - Whether only options are returned
- maxResults Signed32(default 100) - The maximum number of items to return per page
- optionId? int - The ID of the option
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetPermissionHolderResponse
Closed record
Fields
- 'type "Group"|"AccountId" - The permission holder type. This is "Group" or "AccountId"
- value string - The permission holder value. This is a group name if the type is "Group" or an account ID if the type is "AccountId"
jira: GetPermissionResponse
Closed record
Fields
- holder GetPermissionHolderResponse - The permission holder
- 'type "View"|"Edit" - The permission type. This is "View" or "Edit"
jira: GetPermissionSchemeGrantQueries
Represents the Queries record for the operation: getPermissionSchemeGrant
Fields
- expand? string - 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:
allReturns all expandable information.fieldReturns information about the custom field granted the permission.groupReturns information about the group that is granted the permission.permissionsReturns all permission grants for each permission scheme.projectRoleReturns information about the project role granted the permission.userReturns information about the user who is granted the permission
jira: GetPermissionSchemeGrantsQueries
Represents the Queries record for the operation: getPermissionSchemeGrants
Fields
- expand? string - 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:
permissionsReturns all permission grants for each permission scheme.userReturns information about the user who is granted the permission.groupReturns information about the group that is granted the permission.projectRoleReturns information about the project role granted the permission.fieldReturns information about the custom field granted the permission.allReturns all expandable information
jira: GetPermissionSchemeQueries
Represents the Queries record for the operation: getPermissionScheme
Fields
- expand? string - 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:
allReturns all expandable information.fieldReturns information about the custom field granted the permission.groupReturns information about the group that is granted the permission.permissionsReturns all permission grants for each permission scheme.projectRoleReturns information about the project role granted the permission.userReturns information about the user who is granted the permission
jira: GetPlanOnlyTeamResponse
Closed record
Fields
- planningStyle "Scrum"|"Kanban" - The planning style for the plan-only team. This is "Scrum" or "Kanban"
- memberAccountIds? string[] - The account IDs of the plan-only team members
- issueSourceId? int - The ID of the issue source for the plan-only team
- name string - The plan-only team name
- sprintLength? int - The sprint length for the plan-only team
- id int - The plan-only team ID
- capacity? decimal - The capacity for the plan-only team
jira: GetPlanQueries
Represents the Queries record for the operation: getPlan
Fields
- useGroupId boolean(default false) - Whether to return group IDs instead of group names. Group names are deprecated
jira: GetPlanResponse
Closed record
Fields
- crossProjectReleases? GetCrossProjectReleaseResponse[] - The cross-project releases included in the plan
- customFields? GetCustomFieldResponse[] - The custom fields for the plan
- issueSources? GetIssueSourceResponse[] - The issue sources included in the plan
- permissions? GetPermissionResponse[] - The permissions for the plan
- name? string - The plan name
- scheduling GetSchedulingResponse - The scheduling settings for the plan
- id int - The plan ID
- leadAccountId? string - The account ID of the plan lead
- exclusionRules? GetExclusionRulesResponse - The exclusion rules for the plan
- lastSaved? string - The date when the plan was last saved in UTC
- status "Active"|"Trashed"|"Archived" - The plan status. This is "Active", "Trashed" or "Archived"
jira: GetPlanResponseForPage
Closed record
Fields
- issueSources? GetIssueSourceResponse[] - The issue sources included in the plan
- name string - The plan name
- id string - The plan ID
- scenarioId string - Default scenario ID
- status "Active"|"Trashed"|"Archived" - The plan status. This is "Active", "Trashed" or "Archived"
jira: GetPlansQueries
Represents the Queries record for the operation: getPlans
Fields
- cursor string(default "") - The cursor to start from. If not provided, the first page will be returned
- includeArchived boolean(default false) - Whether to include archived plans in the results
- maxResults Signed32(default 50) - The maximum number of plans to return per page. The maximum value is 50. The default value is 50
- includeTrashed boolean(default false) - Whether to include trashed plans in the results
jira: GetPoliciesQueries
Represents the Queries record for the operation: getPolicies
Fields
- ids? string - A list of project identifiers. This parameter accepts a comma-separated list
jira: GetPrecomputationsByIDQueries
Represents the Queries record for the operation: getPrecomputationsByID
Fields
jira: GetPrecomputationsQueries
Represents the Queries record for the operation: getPrecomputations
Fields
- maxResults Signed32(default 100) - The maximum number of items to return per page
- functionKey? string[] - The function key in format:
- Forge:
ari:cloud:ecosystem::extension/[App ID]/[Environment ID]/static/[Function key from manifest] - Connect:
[App key]__[Module key]
- Forge:
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetPreferenceQueries
Represents the Queries record for the operation: getPreference
Fields
- 'key string - The key of the preference
jira: GetPrioritiesByPrioritySchemeQueries
Represents the Queries record for the operation: getPrioritiesByPriorityScheme
Fields
- maxResults string(default "50") - The maximum number of items to return per page
- startAt string(default "0") - The index of the first item to return in a page of results (page offset)
jira: GetPrioritySchemesQueries
Represents the Queries record for the operation: getPrioritySchemes
Fields
- expand? string - A comma separated list of additional information to return. "priorities" will return priorities associated with the priority scheme. "projects" will return projects associated with the priority scheme.
expand=priorities,projects
- onlyDefault boolean(default false) - Whether only the default priority is returned
- maxResults string(default "50") - The maximum number of items to return per page
- schemeName string(default "") - The name of scheme to search for
- orderBy "name"|"+name"|"-name" (default "+name") - The ordering to return the priority schemes by
- schemeId? int[] - A set of priority scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example,
schemeId=10000&schemeId=10001
- startAt string(default "0") - The index of the first item to return in a page of results (page offset)
- priorityId? int[] - A set of priority IDs to filter by. To include multiple IDs, provide an ampersand-separated list. For example,
priorityId=10000&priorityId=10001
jira: GetProjectComponentsPaginatedQueries
Represents the Queries record for the operation: getProjectComponentsPaginated
Fields
- maxResults Signed32(default 50) - The maximum number of items to return per page
- query? string - Filter the results using a literal string. Components with a matching
nameordescriptionare returned (case insensitive)
- orderBy? "description"|"-description"|"+description"|"issueCount"|"-issueCount"|"+issueCount"|"lead"|"-lead"|"+lead"|"name"|"-name"|"+name" - Order the results by a field:
descriptionSorts by the component description.issueCountSorts by the count of issues associated with the component.leadSorts by the user key of the component's project lead.nameSorts by component name
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
- componentSource "jira"|"compass"|"auto" (default "jira") - The source of the components to return. Can be
jira(default),compassorauto. Whenautois specified, the API will return connected Compass components if the project is opted into Compass, otherwise it will return Jira components. Defaults tojira
jira: GetProjectComponentsQueries
Represents the Queries record for the operation: getProjectComponents
Fields
- componentSource "jira"|"compass"|"auto" (default "jira") - The source of the components to return. Can be
jira(default),compassorauto. Whenautois specified, the API will return connected Compass components if the project is opted into Compass, otherwise it will return Jira components. Defaults tojira
jira: GetProjectContextMappingQueries
Represents the Queries record for the operation: getProjectContextMapping
Fields
- maxResults Signed32(default 50) - The maximum number of items to return per page
- contextId? int[] - 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)
jira: GetProjectIssueTypeUsagesForStatusQueries
Represents the Queries record for the operation: getProjectIssueTypeUsagesForStatus
Fields
- nextPageToken? string - The cursor for pagination
- maxResults Signed32(default 50) - The maximum number of results to return. Must be an integer between 1 and 200
jira: GetProjectQueries
Represents the Queries record for the operation: getProject
Fields
- expand? string - 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:
descriptionThe project description.issueTypesThe issue types associated with the project.leadThe project lead.projectKeysAll project keys associated with the project.issueTypeHierarchyThe project issue type hierarchy
- properties? string[] - A list of project properties to return for the project. This parameter accepts a comma-separated list
jira: GetProjectRoleDetailsQueries
Represents the Queries record for the operation: getProjectRoleDetails
Fields
- currentMember boolean(default false) - Whether the roles should be filtered to include only those the user is assigned to
- excludeConnectAddons boolean(default false) -
jira: GetProjectRoleQueries
Represents the Queries record for the operation: getProjectRole
Fields
- excludeInactiveUsers boolean(default false) - Exclude inactive users
jira: GetProjectsByPrioritySchemeQueries
Represents the Queries record for the operation: getProjectsByPriorityScheme
Fields
- maxResults string(default "50") - The maximum number of items to return per page
- query string(default "") - The string to query projects on by name
- projectId? int[] - The project IDs to filter by. For example,
projectId=10000&projectId=10001
- startAt string(default "0") - The index of the first item to return in a page of results (page offset)
jira: GetProjectsForIssueTypeScreenSchemeQueries
Represents the Queries record for the operation: getProjectsForIssueTypeScreenScheme
Fields
- maxResults Signed32(default 50) - The maximum number of items to return per page
- query string(default "") -
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetProjectUsagesForStatusQueries
Represents the Queries record for the operation: getProjectUsagesForStatus
Fields
- nextPageToken? string - The cursor for pagination
- maxResults Signed32(default 50) - The maximum number of results to return. Must be an integer between 1 and 200
jira: GetProjectUsagesForWorkflowQueries
Represents the Queries record for the operation: getProjectUsagesForWorkflow
Fields
- nextPageToken? string - The cursor for pagination
- maxResults Signed32(default 50) - The maximum number of results to return. Must be an integer between 1 and 200
jira: GetProjectUsagesForWorkflowSchemeQueries
Represents the Queries record for the operation: getProjectUsagesForWorkflowScheme
Fields
- nextPageToken? string - The cursor for pagination
- maxResults Signed32(default 50) - The maximum number of results to return. Must be an integer between 1 and 200
jira: GetProjectVersionsPaginatedQueries
Represents the Queries record for the operation: getProjectVersionsPaginated
Fields
- expand? string - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:
issuesstatusReturns the number of issues in each status category for each version.operationsReturns actions that can be performed on the specified version.driverReturns the Atlassian account ID of the version driver.approversReturns a list containing the approvers for this version
- maxResults Signed32(default 50) - The maximum number of items to return per page
- query? string - Filter the results using a literal string. Versions with matching
nameordescriptionare returned (case insensitive)
- orderBy? "description"|"-description"|"+description"|"name"|"-name"|"+name"|"releaseDate"|"-releaseDate"|"+releaseDate"|"sequence"|"-sequence"|"+sequence"|"startDate"|"-startDate"|"+startDate" - Order the results by a field:
descriptionSorts by version description.nameSorts by version name.releaseDateSorts by release date, starting with the oldest date. Versions with no release date are listed last.sequenceSorts by the order of appearance in the user interface.startDateSorts by start date, starting with the oldest date. Versions with no start date are listed last
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
- status? string - A list of status values used to filter the results by version status. This parameter accepts a comma-separated list. The status values are
released,unreleased, andarchived
jira: GetProjectVersionsQueries
Represents the Queries record for the operation: getProjectVersions
Fields
jira: GetRecentQueries
Represents the Queries record for the operation: getRecent
Fields
- expand? string - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include:
descriptionReturns the project description.projectKeysReturns all project keys associated with a project.leadReturns information about the project lead.issueTypesReturns all issue types associated with the project.urlReturns the URL associated with the project.permissionsReturns the permissions associated with the project.insightEXPERIMENTAL. Returns the insight details of total issue count and last issue update time for the project.*Returns the project with all available expand options
- properties? StringList[] - EXPERIMENTAL. A list of project properties to return for the project. This parameter accepts a comma-separated list. Invalid property names are ignored
jira: GetRemoteIssueLinksQueries
Represents the Queries record for the operation: getRemoteIssueLinks
Fields
- globalId? string - The global ID of the remote issue link
jira: GetSchedulingResponse
Closed record
Fields
- estimation "StoryPoints"|"Days"|"Hours" - The estimation unit for the plan. This is "StoryPoints", "Days" or "Hours"
- inferredDates "None"|"SprintDates"|"ReleaseDates" - The inferred dates for the plan. This is "None", "SprintDates" or "ReleaseDates"
- endDate GetDateFieldResponse - The end date field for the plan
- startDate GetDateFieldResponse - The start date field for the plan
- dependencies "Sequential"|"Concurrent" - The dependencies for the plan. This is "Sequential" or "Concurrent"
jira: GetScreenSchemesQueries
Represents the Queries record for the operation: getScreenSchemes
Fields
- maxResults Signed32(default 25) - The maximum number of items to return per page
- orderBy? "name"|"-name"|"+name"|"id"|"-id"|"+id" - Order the results by a field:
idSorts by screen scheme ID.nameSorts by screen scheme name
- id? int[] - The list of screen scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example,
id=10000&id=10001
- queryString string(default "") - String used to perform a case-insensitive partial match with screen scheme name
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetScreensForFieldQueries
Represents the Queries record for the operation: getScreensForField
Fields
- maxResults Signed32(default 100) - The maximum number of items to return per page
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetScreensQueries
Represents the Queries record for the operation: getScreens
Fields
- maxResults Signed32(default 100) - The maximum number of items to return per page
- scope? ("GLOBAL"|"TEMPLATE"|"PROJECT")[] - The scope filter string. To filter by multiple scope, provide an ampersand-separated list. For example,
scope=GLOBAL&scope=PROJECT
- orderBy? "name"|"-name"|"+name"|"id"|"-id"|"+id" - Order the results by a field:
idSorts by screen ID.nameSorts by screen name
- id? int[] - The list of screen IDs. To include multiple IDs, provide an ampersand-separated list. For example,
id=10000&id=10001
- queryString string(default "") - String used to perform a case-insensitive partial match with screen name
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetSecurityLevelMembersQueries
Represents the Queries record for the operation: getSecurityLevelMembers
Fields
- expand? string - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:
allReturns all expandable informationfieldReturns information about the custom field granted the permissiongroupReturns information about the group that is granted the permissionprojectRoleReturns information about the project role granted the permissionuserReturns information about the user who is granted the permission
- maxResults string(default "50") - The maximum number of items to return per page
- levelId? string[] - The list of issue security level IDs. To include multiple issue security levels separate IDs with an ampersand:
levelId=10000&levelId=10001
- schemeId? string[] - The list of issue security scheme IDs. To include multiple issue security schemes separate IDs with an ampersand:
schemeId=10000&schemeId=10001
- id? string[] - The list of issue security level member IDs. To include multiple issue security level members separate IDs with an ampersand:
id=10000&id=10001
- startAt string(default "0") - The index of the first item to return in a page of results (page offset)
jira: GetSecurityLevelsQueries
Represents the Queries record for the operation: getSecurityLevels
Fields
- onlyDefault boolean(default false) - When set to true, returns multiple default levels for each security scheme containing a default. If you provide scheme and level IDs not associated with the default, returns an empty page. The default value is false
- maxResults string(default "50") - The maximum number of items to return per page
- schemeId? string[] - The list of issue security scheme IDs. To include multiple issue security schemes, separate IDs with an ampersand:
schemeId=10000&schemeId=10001
- id? string[] - The list of issue security scheme level IDs. To include multiple issue security levels, separate IDs with an ampersand:
id=10000&id=10001
- startAt string(default "0") - The index of the first item to return in a page of results (page offset)
jira: GetSelectableIssueFieldOptionsQueries
Represents the Queries record for the operation: getSelectableIssueFieldOptions
Fields
- maxResults Signed32(default 50) - The maximum number of items to return per page
- projectId? int - Filters the results to options that are only available in the specified project
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetStatusesByIdQueries
Represents the Queries record for the operation: getStatusesById
Fields
- expand? string - Deprecated. See the deprecation notice for details.
Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:
usagesReturns the project and issue types that use the status in their workflow.workflowUsagesReturns the workflows that use the status
- id string[] - The list of status IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001.
Min items
1, Max items50
jira: GetTeamResponseForPage
Closed record
Fields
- name? string - The team name. This is returned if the type is "PlanOnly"
- id string - The team ID
- 'type "PlanOnly"|"Atlassian" - The team type. This is "PlanOnly" or "Atlassian"
jira: GetTeamsQueries
Represents the Queries record for the operation: getTeams
Fields
- cursor string(default "") - The cursor to start from. If not provided, the first page will be returned
- maxResults Signed32(default 50) - The maximum number of plan teams to return per page. The maximum value is 50. The default value is 50
jira: GetTransitionsQueries
Represents the Queries record for the operation: getTransitions
Fields
- expand? string - 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 thefieldsandupdatefields in Transition issue
- skipRemoteOnlyCondition boolean(default false) - Whether transitions with the condition Hide From User Condition are included in the response
- transitionId? string - The ID of the transition
- 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
jira: GetTrashedFieldsPaginatedQueries
Represents the Queries record for the operation: getTrashedFieldsPaginated
Fields
- expand? "name"|"-name"|"+name"|"trashDate"|"-trashDate"|"+trashDate"|"plannedDeletionDate"|"-plannedDeletionDate"|"+plannedDeletionDate"|"projectsCount"|"-projectsCount"|"+projectsCount" -
- maxResults Signed32(default 50) - The maximum number of items to return per page
- query? string - String used to perform a case-insensitive partial match with field names or descriptions
- id? string[] -
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetUiModificationsQueries
Represents the Queries record for the operation: getUiModifications
Fields
- expand? string - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:
dataReturns UI modification data.contextsReturns UI modification contexts
- maxResults Signed32(default 50) - The maximum number of items to return per page
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetUserDefaultColumnsQueries
Represents the Queries record for the operation: getUserDefaultColumns
Fields
- accountId? string - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5
- username? string - This parameter is no longer available See the deprecation notice for details
jira: GetUserEmailBulkQueries
Represents the Queries record for the operation: getUserEmailBulk
Fields
- accountId GetUserEmailBulkQueriesAccountIdItemsString[] - The account IDs of the users for which emails are required. An
accountIdis 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)
jira: GetUserEmailQueries
Represents the Queries record for the operation: getUserEmail
Fields
- accountId string - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example,
5b10ac8d82e05b22cc7d4ef5
jira: GetUserGroupsQueries
Represents the Queries record for the operation: getUserGroups
Fields
- accountId string - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5
- 'key? string - This parameter is no longer available. See the deprecation notice for details
- username? string - This parameter is no longer available. See the deprecation notice for details
jira: GetUserNavPropertyQueries
Represents the Queries record for the operation: getUserNavProperty
Fields
- accountId? string - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5
jira: GetUserPropertyKeysQueries
Represents the Queries record for the operation: getUserPropertyKeys
Fields
- accountId? string - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5
- userKey? string - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details
- username? string - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details
jira: GetUserPropertyQueries
Represents the Queries record for the operation: getUserProperty
Fields
- accountId? string - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5
- userKey? string - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details
- username? string - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details
jira: GetUserQueries
Represents the Queries record for the operation: getUser
Fields
- accountId? string - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required
- expand? string - Use expand to include additional information about users in the response. This parameter accepts a comma-separated list. Expand options include:
groupsincludes all groups and nested groups to which the user belongs.applicationRolesincludes details of all the applications to which the user has access
- 'key? string - This parameter is no longer available. See the deprecation notice for details
- username? string - This parameter is no longer available. See the deprecation notice for details
jira: GetUsersFromGroupQueries
Represents the Queries record for the operation: getUsersFromGroup
Fields
- includeInactiveUsers boolean(default false) - Include inactive users
- maxResults Signed32(default 50) - The maximum number of items to return per page (number should be between 1 and 50)
- groupId? string - The ID of the group. This parameter cannot be used with the
groupNameparameter
- groupname? string - As a group's name can change, use of
groupIdis recommended to identify a group.
The name of the group. This parameter cannot be used with thegroupIdparameter
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetValidProjectKeyQueries
Represents the Queries record for the operation: getValidProjectKey
Fields
- 'key? string - The project key
jira: GetValidProjectNameQueries
Represents the Queries record for the operation: getValidProjectName
Fields
- name string - The project name
jira: GetVersionQueries
Represents the Queries record for the operation: getVersion
Fields
- expand? string - Use expand to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include:
operationsReturns the list of operations available for this version.issuesstatusReturns the count of issues in this version for each of the status categories to do, in progress, done, and unmapped. The unmapped property represents the number of issues with a status other than to do, in progress, and done.driverReturns the Atlassian account ID of the version driver.approversReturns a list containing the Atlassian account IDs of approvers for this version
jira: GetVisibleIssueFieldOptionsQueries
Represents the Queries record for the operation: getVisibleIssueFieldOptions
Fields
- maxResults Signed32(default 50) - The maximum number of items to return per page
- projectId? int - Filters the results to options that are only available in the specified project
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetWorkflowProjectIssueTypeUsagesQueries
Represents the Queries record for the operation: getWorkflowProjectIssueTypeUsages
Fields
- nextPageToken? string - The cursor for pagination
- maxResults Signed32(default 50) - The maximum number of results to return. Must be an integer between 1 and 200
jira: GetWorkflowQueries
Represents the Queries record for the operation: getWorkflow
Fields
- workflowName? string - 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
jira: GetWorkflowSchemeIssueTypeQueries
Represents the Queries record for the operation: getWorkflowSchemeIssueType
Fields
- 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
jira: GetWorkflowSchemeProjectAssociationsQueries
Represents the Queries record for the operation: getWorkflowSchemeProjectAssociations
Fields
- 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
jira: GetWorkflowSchemeQueries
Represents the Queries record for the operation: getWorkflowScheme
Fields
- 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
jira: GetWorkflowSchemeUsagesForWorkflowQueries
Represents the Queries record for the operation: getWorkflowSchemeUsagesForWorkflow
Fields
- nextPageToken? string - The cursor for pagination
- maxResults Signed32(default 50) - The maximum number of results to return. Must be an integer between 1 and 200
jira: GetWorkflowsPaginatedQueries
Represents the Queries record for the operation: getWorkflowsPaginated
Fields
- expand? string - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:
transitionsFor each workflow, returns information about the transitions inside the workflow.transitions.rulesFor each workflow transition, returns information about its rules. Transitions are included automatically if this expand is requested.transitions.propertiesFor each workflow transition, returns information about its properties. Transitions are included automatically if this expand is requested.statusesFor each workflow, returns information about the statuses inside the workflow.statuses.propertiesFor each workflow status, returns information about its properties. Statuses are included automatically if this expand is requested.defaultFor each workflow, returns information about whether this is the default workflow.schemesFor each workflow, returns information about the workflow schemes the workflow is assigned to.projectsFor each workflow, returns information about the projects the workflow is assigned to, through workflow schemes.hasDraftWorkflowFor each workflow, returns information about whether the workflow has a draft version.operationsFor each workflow, returns information about the actions that can be undertaken on the workflow
- maxResults Signed32(default 50) - The maximum number of items to return per page
- orderBy? "name"|"-name"|"+name"|"created"|"-created"|"+created"|"updated"|"+updated"|"-updated" - Order the results by a field:
nameSorts by workflow name.createdSorts by create time.updatedSorts by update time
- workflowName? string[] - The name of a workflow to return. To include multiple workflows, provide an ampersand-separated list. For example,
workflowName=name1&workflowName=name2
- queryString? string - String used to perform a case-insensitive partial match with workflow name
- isActive? boolean - Filters active and inactive workflows
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetWorkflowTransitionPropertiesQueries
Represents the Queries record for the operation: getWorkflowTransitionProperties
Fields
- workflowMode "live"|"draft" (default "live") - The workflow status. Set to live for active and inactive workflows, or draft for draft workflows
- 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 - 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
jira: GetWorkflowTransitionRuleConfigurationsQueries
Represents the Queries record for the operation: getWorkflowTransitionRuleConfigurations
Fields
- workflowNames? GetWorkflowTransitionRuleConfigurationsQueriesWorkflowNamesItemsString[] - The list of workflow names to filter by
- types ("postfunction"|"condition"|"validator")[] - The types of the transition rules to return
- withTags? GetWorkflowTransitionRuleConfigurationsQueriesWithTagsItemsString[] - The list of
tagsto filter by
- maxResults Signed32(default 10) - The maximum number of items to return per page
- keys? string[] - The transition rule class keys, as defined in the Connect or the Forge app descriptor, of the transition rules to return
- draft? boolean - Whether draft or published workflows are returned. If not provided, both workflow types are returned
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: GetWorkflowUsagesForStatusQueries
Represents the Queries record for the operation: getWorkflowUsagesForStatus
Fields
- nextPageToken? string - The cursor for pagination
- maxResults Signed32(default 50) - The maximum number of results to return. Must be an integer between 1 and 200
jira: GetWorklogQueries
Represents the Queries record for the operation: getWorklog
Fields
jira: GetWorklogsForIdsQueries
Represents the Queries record for the operation: getWorklogsForIds
Fields
jira: GlobalScopeBean
Closed record
Fields
- attributes? ("notSelectable"|"defaultValue")[] - 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
Closed record
Fields
- expand? string - Expand options that include additional group details in the response
- groupId? string? - The ID of the group, which uniquely identifies the group across all Atlassian products. For example, 952d12c3-5b5b-4d04-bb32-44d383afc4b2
- 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]
jira: GroupDetails
Closed record
Details about a group
Fields
- groupId? string? - The ID of the group, which uniquely identifies the group across all Atlassian products. For example, 952d12c3-5b5b-4d04-bb32-44d383afc4b2
- name? string - The name of the group
jira: GroupLabel
Closed record
A group label
Fields
- text? string - The group label name
- title? string - The title of the group label
- 'type? "ADMIN"|"SINGLE"|"MULTIPLE" - The type of the group label
jira: GroupName
Closed record
Details about a group
Fields
- groupId? string? - The ID of the group, which uniquely identifies the group across all Atlassian products. For example, 952d12c3-5b5b-4d04-bb32-44d383afc4b2
- name? string - The name of group
- self? string - The URL for these group details
jira: HealthCheckResult
Closed record
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
Closed record
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? SimplifiedHierarchyLevel[] - Details about the hierarchy level
jira: HistoryMetadata
Details of issue history metadata
Fields
- activityDescription? string - The activity described in the history record.
- activityDescriptionKey? string - The key of the activity described in the history record.
- actor? HistoryMetadataParticipant - Details of the user whose action created the history record.
- cause? HistoryMetadataParticipant - Details of the cause that triggered the creation the history record.
- description? string - The description of the history record.
- descriptionKey? string - The description key of 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.
- extraData? record { string... } - Additional arbitrary information about the history record.
- generator? HistoryMetadataParticipant - Details of the system that generated the history record.
- 'type? string - The type of the history record.
jira: HistoryMetadataParticipant
Details of user or system associated with a issue history metadata item
Fields
- avatarUrl? string - The URL to an avatar for 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.
- id? string - The ID of the user or system associated with a history record.
- 'type? string - The type of 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
- link? string - The URL of the tooltip, used only for a status icon. If not set, the status icon in Jira is not clickable.
- 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".
- url16x16? string - The URL of an icon that displays at 16x16 pixel in Jira.
jira: IdBean
Closed record
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
Closed record
Fields
- id? int - The ID of the referenced item
- 'key? string - The key of the referenced item
jira: IncludedFields
Closed record
Fields
- excluded? string[] -
- actuallyIncluded? string[] -
- included? string[] -
jira: IssueArchivalSyncRequest
Closed record
List of Issue Ids Or Keys that are to be archived or unarchived
Fields
- issueIdsOrKeys? string[] -
jira: IssueArchivalSyncResponse
Closed record
Number of archived/unarchived issues and list of errors that occurred during the action, if any
Fields
- errors? Errors -
- numberOfIssuesUpdated? int -
jira: IssueBean
Closed record
Details about an issue
Fields
- schema? record { JsonTypeBean... } - The schema describing each field present on the issue
- editmeta? IssueUpdateMetadata - The metadata for the fields on the issue that can be amended
- fieldsToInclude? IncludedFields -
- changelog? PageOfChangelogs - Details of changelogs associated with the issue
- transitions? IssueTransition[] - The transitions that can be performed on the issue
- renderedFields? record {} - The rendered value of each field present on the issue
- expand? string - Expand options that include additional issue details in the response
- names? record { string... } - The ID and name of each field present on the issue
- operations? Operations - The operations that can be performed on the issue
- versionedRepresentations? record { record {}... } - The versions of each field on the issue
- self? string - The URL of the issue details
- id? string - The ID of the issue
- fields? record {} -
- 'key? string - The key of the issue
- properties? record {} - Details of the issue properties identified in the request
jira: IssueBulkDeletePayload
Closed record
Issue Bulk Delete Payload
Fields
- selectedIssueIdsOrKeys string[] - List of issue IDs or keys which are to be bulk deleted. These IDs or keys can be from different projects and issue types
- sendBulkNotification boolean?(default true) - A boolean value that indicates whether to send a bulk change notification when the issues are being deleted.
If
true, dispatches a bulk notification email to users about the updates
jira: IssueBulkEditField
Closed record
Fields
- isRequired? boolean - Indicates whether the field is mandatory for the operation
- multiSelectFieldOptions? ("ADD"|"REMOVE"|"REPLACE"|"REMOVE_ALL")[] - Specifies supported actions (like add, replace, remove) on multi-select fields via an enum
- fieldOptions? IssueBulkOperationsFieldOption[] - A list of options related to the field, applicable in contexts where multiple selections are allowed
- name? string - The display name of the field
- description? string - Description of the field
- searchUrl? string - A URL to fetch additional data for the field
- id? string - The unique ID of the field
- 'type? string - The type of the field
jira: IssueBulkEditPayload
Closed record
Issue Bulk Edit Payload
Fields
- selectedIssueIdsOrKeys string[] - List of issue IDs or keys which are to be bulk edited. These IDs or keys can be from different projects and issue types
- selectedActions string[] - List of all the field IDs that are to be bulk edited. Each field ID in this list corresponds to a specific attribute of an issue that is set to be modified in the bulk edit operation. The relevant field ID can be obtained by calling the Bulk Edit Get Fields REST API (documentation available on this page itself)
- sendBulkNotification boolean?(default true) - A boolean value that indicates whether to send a bulk change notification when the issues are being edited.
If
true, dispatches a bulk notification email to users about the updates
- editedFieldsInput JiraIssueFields - An object that defines the values to be updated in specified fields of an issue. The structure and content of this parameter vary depending on the type of field being edited. Although the order is not significant, ensure that field IDs align with those in selectedActions
jira: IssueBulkMovePayload
Closed record
Issue Bulk Move Payload
Fields
- sendBulkNotification boolean?(default true) - A boolean value that indicates whether to send a bulk change notification when the issues are being moved.
If
true, dispatches a bulk notification email to users about the updates
- targetToSourcesMapping? record { TargetToSourcesMapping... } - An object representing the mapping of issues and data related to destination entities, like fields and statuses, that are required during a bulk move.
The key is a string that is created by concatenating the following three entities in order, separated by commas. The format is
<project ID or key>,<issueType ID>,<parent ID or key>. It should be unique across mappings provided in the payload. If you provide multiple mappings for the same key, only one will be processed. However, the operation won't fail, so the error may be hard to track down.- Destination project (Required): ID or key of the project to which the issues are being moved.
- Destination issueType (Required): ID of the issueType to which the issues are being moved.
- Destination parent ID or key (Optional): ID or key of the issue which will become the parent of the issues being moved. Only required when the destination issueType is a subtask
jira: IssueBulkOperationsFieldOption
Closed record
jira: IssueBulkTransitionForWorkflow
Closed record
Fields
- isTransitionsFiltered? boolean - Indicates whether all the transitions of this workflow are available in the transitions list or not
- transitions? SimplifiedIssueTransition[] - List of transitions available for issues from the request which are associated with this workflow. This list includes only those transitions that are common across the issues in this workflow and do not involve any additional field updates.
- issues? string[] - List of issue keys from the request which are associated with this workflow
jira: IssueBulkTransitionPayload
Closed record
Issue Bulk Transition Payload
Fields
- sendBulkNotification boolean?(default true) - A boolean value that indicates whether to send a bulk change notification when the issues are being transitioned.
If
true, dispatches a bulk notification email to users about the updates
- bulkTransitionInputs BulkTransitionSubmitInput[] - List of objects and each object has two properties:
- Issues that will be bulk transitioned.
- TransitionId that corresponds to a specific transition of issues that share the same workflow
jira: IssueBulkWatchOrUnwatchPayload
Closed record
Issue Bulk Watch Or Unwatch Payload
Fields
- selectedIssueIdsOrKeys string[] - List of issue IDs or keys which are to be bulk watched or unwatched. These IDs or keys can be from different projects and issue types
jira: IssueChangeLog
Closed record
List of changelogs that belong to single issue
Fields
- issueId? string - The ID of the issue
- changeHistories? Changelog[] - List of changelogs that belongs to given issueId
jira: IssueChangelogIds
Closed record
A list of changelog IDs
Fields
- changelogIds int[] - The list of changelog IDs
jira: IssueCommentListRequestBean
Closed record
Fields
- ids int[] - The list of comment IDs. A maximum of 1000 IDs can be specified
jira: IssueContextVariable
An issue specified by ID or key. All the fields of the issue object are available in the Jira expression
Fields
- id? int - The issue ID
- 'type string - Type of custom context variable
- 'key? string - The issue key
jira: IssueCreateMetadata
Closed record
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
Closed record
Lists of issues and entity properties. See Entity properties for more information
Fields
- entitiesIds? int[] - A list of entity property IDs
- properties? record { JsonNode... } - A list of entity property keys and values
jira: IssueEntityPropertiesForMultiUpdate
Closed record
An issue ID with entity property values. See Entity properties for more information
Fields
- issueID? int - The ID of the issue
- properties? record { JsonNode... } - Entity properties to set on the issue. The maximum length of an issue property value is 32768 characters
jira: IssueError
Closed record
Describes the error that occurred when retrieving data for a particular issue
Fields
- errorMessage? string - The error that occurred when fetching this issue
- id? string - The ID of the issue
jira: IssueEvent
Closed record
Details about an issue event
Fields
- name? string - The name of the event
- id? int - The ID of the event
jira: IssueFieldOption
Closed record
Details of the options for a select list issue field
Fields
- id int - The unique identifier for the option. This is only unique within the select field's set of options
- config? IssueFieldOptionConfiguration - Details of the projects the option is available in
- value string - The option's name, which is displayed in Jira
- properties? record {} - The properties of the object, as arbitrary key-value pairs. These properties can be searched using JQL, if the extractions (see Issue Field Option Property Index) are defined in the descriptor for the issue field module
jira: IssueFieldOptionConfiguration
Closed record
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? ("notSelectable"|"defaultValue")[] - DEPRECATED
jira: IssueFieldOptionCreateBean
Fields
- config? IssueFieldOptionConfiguration - Details of the projects the option is available in
- 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.
- value string - The option's name, which is displayed in Jira.
jira: IssueFieldOptionScopeBean
Closed record
Fields
- 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
- projects? int[] - DEPRECATED
- 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
Closed record
Bulk operation filter details
Fields
- currentValue? anydata - The value of properties to perform the bulk operation on
- entityIds? int[] - List of issues to perform the bulk delete operation on
jira: IssueFilterForBulkPropertySet
Closed record
Bulk operation filter details
Fields
- hasProperty? boolean - Whether the bulk operation occurs only when the property is present on or absent from an issue
- currentValue? anydata - The value of properties to perform the bulk operation on
- entityIds? int[] - List of issues to perform the bulk operation on
jira: IssueLayouItemtPayload
Closed record
Defines the payload to configure the issue layout item for a project
Fields
- sectionType? "content"|"primaryContext"|"secondaryContext" - The item section type
- 'type? "FIELD" - The item type. Currently only support FIELD
- itemKey? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
jira: IssueLayoutPayload
Closed record
Defines the payload to configure the issue layouts for a project
Fields
- issueLayoutType? "ISSUE_VIEW"|"ISSUE_CREATE"|"REQUEST_FORM" - The issue layout type
- containerId? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
- items? IssueLayouItemtPayload[] - The configuration of items in the issue layout
- pcri? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
jira: IssueLimitReportResponseBean
Closed record
Fields
- issuesBreachingLimit? record { record { int... }... } - A list of ids of issues breaching the limit and their field count
- issuesApproachingLimit? record { record { int... }... } - A list of ids of issues approaching the limit and their field count
- limits? record { Signed32... } - The fields and their defined limits
jira: IssueLink
Closed record
Details of a link between issues
Fields
- outwardIssue LinkedIssue - Provides details about the linked issue. If presenting this link in a user interface, use the
outwardfield of the issue link type to label the link
- self? string - The URL of the issue link
- id? string - The ID of the issue link
- inwardIssue LinkedIssue - Provides details about the linked issue. If presenting this link in a user interface, use the
inwardfield of the issue link type to label the link
- 'type IssueLinkType - The type of link between the issues
jira: IssueLinkType
Closed record
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
- 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
- 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
idisn't provided. Otherwise, read only. - In the issueLinkType resource it is required on create and optional on update. Otherwise, read only
- In the issueLink resource it is the type of issue link. Required on create when
- self? string - The URL of the issue link type. Read only
- 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
nameisn't provided. Otherwise, read only. - In the issueLinkType resource it is read only
- In the issueLink resource it is the type of issue link. Required on create when
- 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
jira: IssueLinkTypes
Closed record
A list of issue link type beans
Fields
- issueLinkTypes? IssueLinkType[] - The issue link type bean
jira: IssueList
Closed record
A list of issue IDs
Fields
- issueIds string[] - The list of issue IDs
jira: IssueMatches
Closed record
A list of matched issues or errors for each JQL query, in the order the JQL queries were passed
Fields
- matches IssueMatchesForJQL[] -
jira: IssueMatchesForJQL
Closed record
A list of the issues matched to a JQL query or details of errors encountered during matching
Fields
- errors string[] - A list of errors
- matchedIssues int[] - A list of issue IDs
jira: IssuePickerSuggestions
Closed record
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
Closed record
A type of issue suggested for use in auto-completion
Fields
- msg? string - If no issue suggestions are found, returns a message indicating no suggestions were found,
- 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
- label? string - The label of the type of issues suggested for use in auto-completion
- issues? SuggestedIssue[] - A list of issues suggested for use in auto-completion
jira: IssuesAndJQLQueries
Closed record
List of issues and JQL queries
Fields
- issueIds int[] - A list of issue IDs
- jqls string[] - A list of JQL queries
jira: IssueSecurityLevelMember
Closed record
Issue security level member
Fields
- holder PermissionHolder - The user or group being granted the permission. It consists of a
typeand a type-dependentparameter. See Holder object in Get all permission schemes for more information
- id int - The ID of the issue security level member
- issueSecurityLevelId int - The ID of the issue security level
jira: IssueSecuritySchemeToProjectMapping
Details about an project using security scheme mapping
Fields
- issueSecuritySchemeId? string -
- projectId? string -
jira: IssuesJqlMetaDataBean
Closed record
The description of the page of issues loaded by the provided JQL query
Fields
- validationWarnings? string[] - Any warnings related to the JQL query. Present only if the validation mode was set to
warn
- maxResults Signed32 - The maximum number of issues that could be loaded in this evaluation
- count Signed32 - The number of issues that were loaded in this evaluation
- totalCount int - The total number of issues the JQL returned
- startAt int - The index of the first issue
jira: IssuesMetaBean
Closed record
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
- expand? string - Expand options that include additional transition details in the response.
- fields? record { FieldMetadata... } - Details of the fields associated with the issue transition screen. Use this information to populate
fieldsandupdatein a transition request.
- hasScreen? boolean - Whether there is a screen associated with the issue transition.
- id? string - The ID of the issue transition. Required when specifying a transition to undertake.
- 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.
- 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.
- looped? boolean -
- name? string - The name of the issue transition.
- to? StatusDetails - Details of the issue status after the transition.
jira: IssueTransitionStatus
Closed record
Fields
- statusId? Signed32 - The unique ID of the status
- statusName? string - The name of the status
jira: IssueTypeCreateBean
Closed record
Fields
- hierarchyLevel? Signed32 - The hierarchy level of the issue type. Use:
-1for Subtask.0for Base.
0
- name string - The unique name for the issue type. The maximum length is 60 characters
- description? string - The description of the issue type
- 'type? "subtask"|"standard" - Deprecated. Use
hierarchyLevelinstead. See the deprecation notice for details. Whether the issue type issubtypeorstandard. Defaults tostandard
jira: IssueTypeDetails
Closed record
Details about an issue type
Fields
- avatarId? int - The ID of the issue type's avatar
- hierarchyLevel? Signed32 - Hierarchy level of the issue type
- scope? Scope - Details of the next-gen projects the issue type is available in
- name? string - The name of the issue type
- description? string - The description of the issue type
- self? string - The URL of these issue type details
- entityId? string - Unique ID for next-gen projects
- iconUrl? string - The URL of the issue type's avatar
- id? string - The ID of the issue type
- subtask? boolean - Whether this issue type is used to create subtasks
jira: IssueTypeHierarchyPayload
Closed record
The payload for creating an issue type hierarchy
Fields
- onConflict? "FAIL"|"USE"|"NEW" - The conflict strategy to use when the issue type already exists. FAIL - Fail execution, this always needs to be unique; USE - Use the existing entity and ignore new entity parameters
- hierarchyLevel? Signed32 - The hierarchy level of the issue type. 0, 1, 2, 3 .. n; Negative values for subtasks
- name? string - The name of the issue type
- pcri? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
jira: IssueTypeIds
Closed record
The list of issue type IDs
Fields
- issueTypeIds string[] - The list of issue type IDs
jira: IssueTypeIdsToRemove
Closed record
The list of issue type IDs to be removed from the field configuration scheme
Fields
- issueTypeIds string[] - The list of issue type IDs. Must contain unique values not longer than 255 characters and not be empty. Maximum of 100 IDs
jira: IssueTypeInfo
Closed record
Details of an issue type
Fields
- avatarId? int - The avatar of the issue type
- name? string - The name of the issue type
- id? int - The ID of the issue type
jira: IssueTypeIssueCreateMetadata
Closed record
Details of the issue creation metadata for an issue type
Fields
- expand? string - Expand options that include additional issue type metadata details in the response
- avatarId? int - The ID of the issue type's avatar
- hierarchyLevel? Signed32 - Hierarchy level of the issue type
- scope? Scope - Details of the next-gen projects the issue type is available in
- name? string - The name of the issue type
- description? string - The description of the issue type
- self? string - The URL of these issue type details
- entityId? string - Unique ID for next-gen projects
- iconUrl? string - The URL of the issue type's avatar
- id? string - The ID of the issue type
- subtask? boolean - Whether this issue type is used to create subtasks
- fields? record { FieldMetadata... } - List of the fields available when creating an issue for the issue type
jira: IssueTypePayload
Closed record
The payload for creating an issue type
Fields
- avatarId? int? - The avatar ID of the issue type. Go to https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-avatars/#api-rest-api-3-avatar-type-system-get to choose an avatarId existing in Jira
- onConflict? "FAIL"|"USE"|"NEW" - The conflict strategy to use when the issue type already exists. FAIL - Fail execution, this always needs to be unique; USE - Use the existing entity and ignore new entity parameters
- hierarchyLevel? Signed32 - The hierarchy level of the issue type. 0, 1, 2, 3 .. n; Negative values for subtasks
- name? string - The name of the issue type
- description? string? - The description of the issue type
- pcri? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
jira: IssueTypeProjectCreatePayload
Closed record
The payload for creating issue types in a project
Fields
- issueTypeHierarchy? IssueTypeHierarchyPayload[]? - Defines the issue type hierarhy to be created and used during this project creation. This will only add new levels if there isn't an existing level
- issueTypeScheme? IssueTypeSchemePayload - The payload for creating issue type schemes
- issueTypes? IssueTypePayload[]? - Only needed if you want to create issue types, you can otherwise use the ids of issue types in the scheme configuration
jira: IssueTypeScheme
Closed record
Details of an issue type scheme
Fields
- isDefault? boolean - Whether the issue type scheme is the default
- defaultIssueTypeId? string - The ID of the default issue type of the issue type scheme
- name string - The name of the issue type scheme
- description? string - The description of the issue type scheme
- id string - The ID of the issue type scheme
jira: IssueTypeSchemeDetails
Closed record
Details of an issue type scheme and its associated issue types
Fields
- 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
- 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
jira: IssueTypeSchemeID
Closed record
The ID of an issue type scheme
Fields
- issueTypeSchemeId string - The ID of the issue type scheme
jira: IssueTypeSchemeMapping
Closed record
Issue type scheme item
Fields
- issueTypeId string - The ID of the issue type
- issueTypeSchemeId string - The ID of the issue type scheme
jira: IssueTypeSchemePayload
Closed record
The payload for creating issue type schemes
Fields
- defaultIssueTypeId? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
- issueTypeIds? ProjectCreateResourceIdentifier[] - The issue type IDs for the issue type scheme
- name? string - The name of the issue type scheme
- description? string? - The description of the issue type scheme
- pcri? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
jira: IssueTypeSchemeProjectAssociation
Closed record
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
Closed record
Issue type scheme with a list of the projects that use it
Fields
- projectIds string[] - The IDs of the projects using the issue type scheme
- issueTypeScheme IssueTypeScheme - Details of an issue type scheme
jira: IssueTypeSchemeUpdateDetails
Closed record
Details of the name, description, and default issue type for an issue type scheme
Fields
- defaultIssueTypeId? string - The ID of the default issue type of the issue type scheme
- 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
jira: IssueTypeScreenScheme
Closed record
Details of an issue type screen scheme
Fields
- name string - The name of the issue type screen scheme
- description? string - The description of the issue type screen scheme
- id string - The ID of the issue type screen scheme
jira: IssueTypeScreenSchemeDetails
Closed record
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
Closed record
The ID of an issue type screen scheme
Fields
- id string - The ID of the issue type screen scheme
jira: IssueTypeScreenSchemeItem
Closed record
The screen scheme for an issue type
Fields
- 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
- issueTypeScreenSchemeId string - The ID of the issue type screen scheme
- screenSchemeId string - The ID of the screen scheme
jira: IssueTypeScreenSchemeMapping
Closed record
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
Closed record
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: IssueTypeScreenSchemePayload
Closed record
Defines the payload for the issue type screen schemes. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-type-screen-schemes/\#api-rest-api-3-issuetypescreenscheme-post
Fields
- name? string - The name of the issue type screen scheme
- description? string - The description of the issue type screen scheme
- defaultScreenScheme? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
- pcri? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
- explicitMappings? record { ProjectCreateResourceIdentifier... } - 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: IssueTypeScreenSchemeProjectAssociation
Closed record
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
Closed record
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
Closed record
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
Closed record
Details about the mapping between issue types and a workflow
Fields
- 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
- workflow? string - The name of the workflow. Optional if updating the workflow-issue types mapping
- defaultMapping? boolean - Whether the workflow is the default workflow for the workflow scheme
- issueTypes? string[] - The list of issue type IDs
jira: IssueTypeToContextMapping
Closed record
Mapping of an issue type to a context
Fields
- issueTypeId? string - The ID of the issue type
- contextId string - The ID of the context
- isAnyIssueType? boolean - Whether the context is mapped to any issue type
jira: IssueTypeUpdateBean
Closed record
Fields
- avatarId? int - The ID of an issue type avatar. This can be obtained be obtained from the following endpoints:
- name? string - The unique name for the issue type. The maximum length is 60 characters
- description? string - The description of the issue type
jira: IssueTypeWithStatus
Closed record
Status details for an issue type
Fields
- name string - The name of the issue type
- self string - The URL of the issue type's status details
- statuses StatusDetails[] - List of status details for the issue type
- id string - The ID of the issue type
- subtask boolean - Whether this issue type represents subtasks
jira: IssueTypeWorkflowMapping
Closed record
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
- 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
- workflow? string - The name of the workflow
jira: IssueUpdateDetails
Details of an issue update request
Fields
- 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 inupdate.
- historyMetadata? HistoryMetadata - Additional issue history details.
- properties? EntityProperty[] - Details of issue properties to be add or update.
- transition? IssueTransition - Details of a transition. Required when performing a transition, optional when creating or editing an issue.
- update? record { FieldUpdateOperation[]... } - A Map containing the field field name and a list of operations to perform on the issue screen field. Note that fields included in here cannot be included in
fields.
jira: IssueUpdateMetadata
A list of editable field details
Fields
- fields? record { FieldMetadata... } -
jira: JexpEvaluateCtxIssues
Closed record
The JQL specifying the issues available in the evaluated Jira expression under the issues context variable. This bean will be replacing JexpIssues bean as part of new evaluate endpoint
Fields
- jql? JexpEvaluateCtxJqlIssues - The JQL query that specifies the set of issues available in the Jira expression
jira: JexpEvaluateCtxJqlIssues
Closed record
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 nextPageToken and maxResults properties. This bean will be replacing JexpJqlIssues bean as part of new evaluate endpoint
Fields
- maxResults? Signed32 - The maximum number of issues to return from the JQL query. max results value considered may be lower than the number specific here
- nextPageToken? string - The token for a page to fetch that is not the first page. The first page has a
nextPageTokenofnull. Use thenextPageTokento fetch the next page of issues
- query? string - The JQL query, required to be bounded. Additionally,
orderByclause can contain a maximum of 7 fields
jira: JExpEvaluateIssuesJqlMetaDataBean
Closed record
The description of the page of issues loaded by the provided JQL query.This bean will be replacing IssuesJqlMetaDataBean bean as part of new evaluate endpoint
Fields
- isLast? boolean - Indicates whether this is the last page of the paginated response
- nextPageToken string - Next Page token for the next page of issues
jira: JExpEvaluateIssuesMetaBean
Closed record
Meta data describing the issues context variable.This bean will be replacing IssuesMetaBean bean as part of new evaluate endpoint
Fields
- jql? JExpEvaluateIssuesJqlMetaDataBean - The description of the page of issues loaded by the provided JQL query.This bean will be replacing IssuesJqlMetaDataBean bean as part of new
evaluateendpoint
jira: JExpEvaluateJiraExpressionResultBean
Closed record
The result of evaluating a Jira expression.This bean will be replacing JiraExpressionResultBean bean as part of new evaluate endpoint
Fields
- meta? JExpEvaluateMetaDataBean - Contains various characteristics of the performed expression evaluation
- 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.)
jira: JExpEvaluateMetaDataBean
Closed record
Contains information about the expression evaluation. This bean will be replacing JiraExpressionEvaluationMetaDataBean bean as part of new evaluate endpoint
Fields
- complexity? JiraExpressionsComplexityBean - Contains information about the expression complexity. For example, the number of steps it took to evaluate the expression
- issues? JExpEvaluateIssuesMetaBean - Contains information about the
issuesvariable in the context. For example, is the issues were loaded with JQL, information about the page will be included here
jira: JexpIssues
Closed record
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
Closed record
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
- maxResults? Signed32 - The maximum number of issues to return from the JQL query. Inspect
meta.issues.jql.maxResultsin the response to ensure the maximum value has not been exceeded
- query? string - The JQL query
- startAt? int - The index of the first issue to return from the JQL query
- validation "strict"|"warn"|"none" (default "strict") - Determines how to validate the JQL query and treat the validation results
jira: JiraCascadingSelectField
Closed record
Fields
- childOptionValue? JiraSelectedOptionField -
- parentOptionValue JiraSelectedOptionField -
- fieldId string -
jira: JiraColorField
Closed record
Fields
- color JiraColorInput -
- fieldId string -
jira: JiraColorInput
Closed record
Fields
- name string -
jira: JiraComponentField
Closed record
Fields
- componentId int -
jira: JiraDateField
Closed record
Fields
- date? JiraDateInput -
- fieldId string -
jira: JiraDateInput
Closed record
Fields
- formattedDate string -
jira: JiraDateTimeField
Closed record
Fields
- dateTime JiraDateTimeInput -
- fieldId string -
jira: JiraDateTimeInput
Closed record
Fields
- formattedDateTime string -
jira: JiraDurationField
Closed record
Fields
- originalEstimateField string -
jira: JiraExpressionAnalysis
Closed record
Details about the analysed Jira expression
Fields
- valid boolean - Whether the expression is valid and the interpreter will evaluate it. Note that the expression may fail at runtime (for example, if it executes too many expensive operations)
- complexity? JiraExpressionComplexity - Details about the complexity of the analysed Jira expression
- expression string - The analysed expression
- 'type? string - EXPERIMENTAL. The inferred type of the expression
- errors? JiraExpressionValidationError[] - A list of validation errors. Not included if the expression is valid
jira: JiraExpressionComplexity
Closed record
Details about the complexity of the analysed Jira expression
Fields
- variables? record { string... } - Variables used in the formula, mapped to the parts of the expression they refer to
- expensiveOperations string - Information that can be used to determine how many expensive operations the evaluation of the expression will perform. This information may be a formula or number. For example:
issues.map(i => i.comments)performs as many expensive operations as there are issues on the issues list. So this parameter returnsN, whereNis the size of issue list.new Issue(10010).commentsgets comments for one issue, so its complexity is2(1to retrieve issue 10010 from the database plus1to get its comments)
jira: JiraExpressionEvalContextBean
Closed record
Fields
- issue? IdOrKeyBean - The issue that is available under the
issuevariable when evaluating the expression
- custom? CustomContextVariable[] - Custom context variables and their types. These variable types are available for use in a custom context:
- sprint? int - The ID of the sprint that is available under the
sprintvariable when evaluating the expression
- project? IdOrKeyBean - The project that is available under the
projectvariable when evaluating the expression
- serviceDesk? int - The ID of the service desk that is available under the
serviceDeskvariable when evaluating the expression
- issues? JexpIssues - The collection of issues that is available under the
issuesvariable when evaluating the expression
- board? int - The ID of the board that is available under the
boardvariable when evaluating the expression
- customerRequest? int - The ID of the customer request that is available under the
customerRequestvariable 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
Closed record
Fields
- expression string - The Jira expression to evaluate
- context? JiraExpressionEvalContextBean - The context in which the Jira expression is evaluated
jira: JiraExpressionEvaluateContextBean
Closed record
Fields
- issue? IdOrKeyBean - The issue that is available under the
issuevariable when evaluating the expression
- custom? CustomContextVariable[] - Custom context variables and their types. These variable types are available for use in a custom context:
- sprint? int - The ID of the sprint that is available under the
sprintvariable when evaluating the expression
- project? IdOrKeyBean - The project that is available under the
projectvariable when evaluating the expression
- serviceDesk? int - The ID of the service desk that is available under the
serviceDeskvariable when evaluating the expression
- issues? JexpEvaluateCtxIssues - The collection of issues that is available under the
issuesvariable when evaluating the expression
- board? int - The ID of the board that is available under the
boardvariable when evaluating the expression
- customerRequest? int - The ID of the customer request that is available under the
customerRequestvariable 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: JiraExpressionEvaluateRequestBean
Closed record
The request to evaluate a Jira expression. This bean will be replacing JiraExpressionEvaluateRequest as part of new evaluate endpoint
Fields
- expression string - The Jira expression to evaluate
- context? JiraExpressionEvaluateContextBean - The context in which the Jira expression is evaluated
jira: JiraExpressionEvaluationMetaDataBean
Closed record
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
issuesvariable in the context. For example, is the issues were loaded with JQL, information about the page will be included here
jira: JiraExpressionForAnalysis
Closed record
Details of Jira expressions for analysis
Fields
- contextVariables? record { string... } - Context variables and their types. The type checker assumes that common context variables, such as
issueorproject, are available in context and sets their type. Use this property to override the default types or provide details of new variables
- expressions string[] - The list of Jira expressions to analyse
jira: JiraExpressionResult
Closed record
The result of evaluating a Jira expression
Fields
- meta? JiraExpressionEvaluationMetaDataBean - Contains various characteristics of the performed expression evaluation
- 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.)
jira: JiraExpressionsAnalysis
Closed record
Details about the analysed Jira expression
Fields
- results JiraExpressionAnalysis[] - The results of Jira expressions analysis
jira: JiraExpressionsComplexityBean
Closed record
Fields
- beans JiraExpressionsComplexityValueBean - The number of Jira REST API beans returned in the response
- 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
- primitiveValues JiraExpressionsComplexityValueBean - The number of primitive values returned in the response
- 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
jira: JiraExpressionsComplexityValueBean
Closed record
Fields
- 'limit Signed32 - The maximum allowed complexity. The evaluation will fail if this value is exceeded
- value Signed32 - The complexity value of the current expression
jira: JiraExpressionValidationError
Closed record
Details about syntax and type errors. The error details apply to the entire expression, unless the object includes:
lineandcolumnexpression
Fields
- expression? string - The part of the expression in which the error occurred
- line? Signed32 - The text line in which the error occurred
- column? Signed32 - The text column in which the error occurred
- message string - Details about the error
- 'type "syntax"|"type"|"other" - The error type
jira: JiraGroupInput
Closed record
Fields
- groupName string -
jira: JiraIssueFields
Closed record
Fields
- multipleVersionPickerFields? JiraMultipleVersionPickerField[] - Edit a multi-version picker field like Fix Versions/Affects Versions:
- Options include
ADD,REPLACE,REMOVE, orREMOVE_ALLfor bulk edits. - To clear the field, use the
REMOVE_ALLoption with an emptyversionsarray
- Options include
- richTextFields? JiraRichTextField[] - Add or clear a rich text field:
- To add, provide
adfValue. Note that rich text fields only support ADF values. - To clear, use an empty
richTextobject.
- To add, provide
- singleSelectClearableUserPickerFields? JiraSingleSelectUserPickerField[] - Edit assignment for single select user picker fields like Assignee/Reporter:
- To assign an issue, specify the user's
accountId. - To unassign an issue, set
usertonull. - For automatic assignment, set
accountIdto-1
- To assign an issue, specify the user's
- multipleSelectFields? JiraMultipleSelectField[] - Add or clear a multi-select field:
- To add, provide an array of options with
optionIds. - To clear, use an empty
optionsarray
- To add, provide an array of options with
- timeTrackingField? JiraTimeTrackingField - Edit the time tracking field
- colorFields? JiraColorField[] - Add or clear a color field:
- To add, specify the color
name. Available colors are:purple,blue,green,teal,yellow,orange,grey,dark purple,dark blue,dark green,dark teal,dark yellow,dark orange,dark grey. - To clear, set the color
nameto an empty string
- To add, specify the color
- priority? JiraPriorityField - Set the priority of an issue by specifying a
priorityId
- singleVersionPickerFields? JiraSingleVersionPickerField[] - Add or clear a single version picker field:
- To add, specify the version with a
versionId. - To clear, set
versionIdto-1
- To add, specify the version with a
- cascadingSelectFields? JiraCascadingSelectField[] - Add or clear a cascading select field:
- To add, specify
optionIdfor both parent and child. - To clear the child, set its
optionIdto null. - To clear both, set the parent's
optionIdto null
- To add, specify
- multipleSelectClearableUserPickerFields? JiraMultipleSelectUserPickerField[] - Assign or unassign multiple users to/from a field:
- To assign, provide an array of user
accountIds. - To clear, set
userstonull
- To assign, provide an array of user
- issueType? JiraIssueTypeField - Set the issue type field by providing an
issueTypeId
- originalEstimateField? JiraDurationField - Edit the original estimate field
- urlFields? JiraUrlField[] - Add or clear a URL field:
- To add, provide the
urlwith the desired URL value. - To clear, set
urlto an empty string
- To add, provide the
- singleSelectFields? JiraSingleSelectField[] - Add or clear a single select field:
- To add, specify the option with an
optionId. - To clear, pass an option with
optionIdas-1
- To add, specify the option with an
- multipleGroupPickerFields? JiraMultipleGroupPickerField[] - Add or clear a multi-group picker field:
- To add groups, provide an array of groups with
groupNames. - To clear all groups, use an empty
groupsarray
- To add groups, provide an array of groups with
- clearableNumberFields? JiraNumberField[] - Add or clear a number field:
- To add, specify a numeric
value. - To clear, set
valuetonull
- To add, specify a numeric
- labelsFields? JiraLabelsField[] - Edit a labels field:
- Options include
ADD,REPLACE,REMOVE, orREMOVE_ALLfor bulk edits. - To clear labels, use the
REMOVE_ALLoption with an emptylabelsarray
- Options include
- multiselectComponents? JiraMultiSelectComponentField - Edit a multi select components field:
- Options include
ADD,REPLACE,REMOVE, orREMOVE_ALLfor bulk edits. - To clear, use the
REMOVE_ALLoption with an emptycomponentsarray
- Options include
- dateTimePickerFields? JiraDateTimeField[] - Add or clear the planned start date and time:
- To add, specify the date and time in ISO format for
formattedDateTime. - To clear, provide an empty string for
formattedDateTime
- To add, specify the date and time in ISO format for
- singleGroupPickerFields? JiraSingleGroupPickerField[] - Add or clear a single group picker field:
- To add, specify the group with
groupName. - To clear, set
groupNameto an empty string
- To add, specify the group with
- datePickerFields? JiraDateField[] - Add or clear a date picker field:
- To add, specify the date in
d/mmm/yyformat or ISO formatdd-mm-yyyy. - To clear, set
formattedDateto an empty string
- To add, specify the date in
- singleLineTextFields? JiraSingleLineTextField[] - Add or clear a single line text field:
- To add, provide the
textvalue. - To clear, set
textto an empty string
- To add, provide the
- status? JiraStatusInput -
jira: JiraIssueTypeField
Closed record
Fields
- issueTypeId string -
jira: JiraLabelPropertiesInputJackson1
Closed record
Fields
- color? "GREY_LIGHTEST"|"GREY_LIGHTER"|"GREY"|"GREY_DARKER"|"GREY_DARKEST"|"PURPLE_LIGHTEST"|"PURPLE_LIGHTER"|"PURPLE"|"PURPLE_DARKER"|"PURPLE_DARKEST"|"BLUE_LIGHTEST"|"BLUE_LIGHTER"|"BLUE"|"BLUE_DARKER"|"BLUE_DARKEST"|"TEAL_LIGHTEST"|"TEAL_LIGHTER"|"TEAL"|"TEAL_DARKER"|"TEAL_DARKEST"|"GREEN_LIGHTEST"|"GREEN_LIGHTER"|"GREEN"|"GREEN_DARKER"|"GREEN_DARKEST"|"LIME_LIGHTEST"|"LIME_LIGHTER"|"LIME"|"LIME_DARKER"|"LIME_DARKEST"|"YELLOW_LIGHTEST"|"YELLOW_LIGHTER"|"YELLOW"|"YELLOW_DARKER"|"YELLOW_DARKEST"|"ORANGE_LIGHTEST"|"ORANGE_LIGHTER"|"ORANGE"|"ORANGE_DARKER"|"ORANGE_DARKEST"|"RED_LIGHTEST"|"RED_LIGHTER"|"RED"|"RED_DARKER"|"RED_DARKEST"|"MAGENTA_LIGHTEST"|"MAGENTA_LIGHTER"|"MAGENTA"|"MAGENTA_DARKER"|"MAGENTA_DARKEST" -
- name? string -
jira: JiraLabelsField
Closed record
Fields
- labelProperties? JiraLabelPropertiesInputJackson1[] -
- bulkEditMultiSelectFieldOption "ADD"|"REMOVE"|"REPLACE"|"REMOVE_ALL" -
- fieldId string -
- labels JiraLabelsInput[] -
jira: JiraLabelsInput
Closed record
Fields
- name string -
jira: JiraMultipleGroupPickerField
Closed record
Fields
- groups JiraGroupInput[] -
- fieldId string -
jira: JiraMultipleSelectField
Closed record
Fields
- options JiraSelectedOptionField[] -
- fieldId string -
jira: JiraMultipleSelectUserPickerField
Closed record
Fields
- users? JiraUserField[] -
- fieldId string -
jira: JiraMultipleVersionPickerField
Closed record
Fields
- versions JiraVersionField[] -
- bulkEditMultiSelectFieldOption "ADD"|"REMOVE"|"REPLACE"|"REMOVE_ALL" -
- fieldId string -
jira: JiraMultiSelectComponentField
Closed record
Fields
- components JiraComponentField[] -
- bulkEditMultiSelectFieldOption "ADD"|"REMOVE"|"REPLACE"|"REMOVE_ALL" -
- fieldId string -
jira: JiraNumberField
Closed record
Fields
- value? decimal -
- fieldId string -
jira: JiraPriorityField
Closed record
Fields
- priorityId string -
jira: JiraRichTextField
Closed record
Fields
- richText JiraRichTextInput -
- fieldId string -
jira: JiraRichTextInput
Closed record
Fields
- adfValue? record {} -
jira: JiraSelectedOptionField
Closed record
Fields
- optionId? int -
jira: JiraSingleGroupPickerField
Closed record
Fields
- fieldId string -
- group JiraGroupInput -
jira: JiraSingleLineTextField
Closed record
Fields
- text string -
- fieldId string -
jira: JiraSingleSelectField
Closed record
Add or clear a single select field:
- To add, specify the option with an
optionId. - To clear, pass an option with
optionIdas-1
Fields
- fieldId string -
- option JiraSelectedOptionField -
jira: JiraSingleSelectUserPickerField
Closed record
Fields
- user? JiraUserField -
- fieldId string -
jira: JiraSingleVersionPickerField
Closed record
Fields
- version JiraVersionField -
- fieldId string -
jira: JiraStatus
Closed record
Details of a status
Fields
- workflowUsages? WorkflowUsages[]? - Deprecated. See the deprecation notice for details.
The workflows that use this status. Only available if the
workflowUsagesexpand is requested
- scope? StatusScope - The scope of the status
- name? string - The name of the status
- description? string - The description of the status
- id? string - The ID of the status
- usages? ProjectIssueTypes[]? - Deprecated. See the deprecation notice for details.
Projects and issue types where the status is used. Only available if the
usagesexpand is requested
- statusCategory? "TODO"|"IN_PROGRESS"|"DONE" - The category of the status
jira: JiraStatusInput
Closed record
Fields
- statusId string -
jira: JiraTimeTrackingField
Closed record
Fields
- timeRemaining string -
jira: JiraUrlField
Closed record
Fields
- url string -
- fieldId string -
jira: JiraUserField
Closed record
Fields
- accountId string -
jira: JiraVersionField
Closed record
Fields
- versionId? string -
jira: JiraWorkflow
Closed record
Details of a workflow
Fields
- created? string? - The creation date of the workflow
- loopedTransitionContainerLayout? WorkflowLayout? - The starting point for the statuses in the workflow
- description? string - The description of the workflow
- transitions? WorkflowTransitions[] - The transitions of the workflow. Note that a transition can have either the deprecated
to/fromfields or thetoStatusReference/linksfields, but never both nor a combination
- version? DocumentVersion - The current version details of this workflow scheme
- startPointLayout? WorkflowLayout? - The starting point for the statuses in the workflow
- isEditable? boolean - Indicates if the workflow can be edited
- scope? WorkflowScope - The scope of the workflow
- name? string - The name of the workflow
- statuses? WorkflowReferenceStatus[] - The statuses referenced in this workflow
- id? string - The ID of the workflow
- usages? ProjectIssueTypes[]? - Deprecated. See the deprecation notice for details.
Use the optional
workflows.usagesexpand to get additional information about the projects and issue types associated with the requested workflows
- updated? string? - The last edited date of the workflow
- taskId? string? - If there is a current asynchronous task operation for this workflow
jira: JiraWorkflowStatus
Closed record
Details of a status
Fields
- scope? WorkflowScope - The scope of the workflow
- name? string - The name of the status
- description? string - The description of the status
- id? string - The ID of the status
- usages? ProjectIssueTypes[]? - Deprecated. See the deprecation notice for details.
The
statuses.usagesexpand is an optional parameter that can be used when reading and updating statuses in Jira. It provides additional information about the projects and issue types associated with the requested statuses
- statusCategory? "TODO"|"IN_PROGRESS"|"DONE" - The category of the status
- statusReference? string - The reference of the status
jira: JQLCountRequestBean
Closed record
Fields
jira: JQLCountResultsBean
Closed record
Fields
- count? int - Number of issues matching JQL query
jira: JqlFunctionPrecomputationBean
Closed record
Jql function precomputation
Fields
- 'field? string - The field the function was executed against
- functionName? string - The name of the function
- created? string - The timestamp of the precomputation creation
- arguments? string[] - The list of arguments function was invoked with
- id? string - The id of the precomputation
- used? string - The timestamp of the precomputation last usage
- 'error? string - The error message to be displayed to the user
- functionKey? string - The function key
- updated? string - The timestamp of the precomputation last update
- value? string - The JQL fragment stored as the precomputation
- operator? string - The operator in context of which function was executed
jira: JqlFunctionPrecomputationGetByIdRequest
Closed record
Request to fetch precomputations by ID
Fields
- precomputationIDs? string[] -
jira: JqlFunctionPrecomputationGetByIdResponse
Closed record
Get precomputations by ID response
Fields
- precomputations? JqlFunctionPrecomputationBean[] - The list of precomputations
- notFoundPrecomputationIDs? string[] - List of precomputations that were not found
jira: JqlFunctionPrecomputationUpdateBean
Closed record
Precomputation id and its new value
Fields
- id string - The id of the precomputation to update
- 'error? string - The error message to be displayed to the user if the given function clause is no longer valid during recalculation of the precomputation
- value? string - The new value of the precomputation
jira: JqlFunctionPrecomputationUpdateRequestBean
Closed record
List of pairs (id and value) for precomputation updates
Fields
- values? JqlFunctionPrecomputationUpdateBean[] -
jira: JqlFunctionPrecomputationUpdateResponse
Closed record
Result of updating JQL Function precomputations
Fields
- notFoundPrecomputationIDs? string[] - List of precomputations that were not found and skipped. Only returned if the request passed skipNotFoundPrecomputations=true
jira: JQLPersonalDataMigrationRequest
Closed record
The JQL queries to be converted
Fields
- queryStrings? string[] - A list of queries with user identifiers. Maximum of 100 queries
jira: JqlQueriesToParse
Closed record
A list of JQL queries to parse
Fields
- queries JqlQueriesToParseQueriesItemsString[] - A list of queries to parse
jira: JqlQueriesToSanitize
Closed record
The list of JQL queries to sanitize for the given account IDs
Fields
- queries JqlQueryToSanitize[] - The list of JQL queries to sanitize. Must contain unique values. Maximum of 20 queries
jira: JqlQuery
Closed record
A parsed JQL query
Fields
- orderBy? JqlQueryOrderByClause - Details of the order-by JQL clause
- 'where? JqlQueryClause - A JQL query clause
jira: JqlQueryClauseTimePredicate
A time predicate for a temporal JQL clause
Fields
- operand JqlQueryClauseOperand - Details of an operand in a JQL clause
- operator "before"|"after"|"from"|"to"|"on"|"during"|"by" - The operator between the field and the operand
jira: JqlQueryField
Closed record
A field used in a JQL query. See Advanced searching - fields reference for more information about fields in JQL queries
Fields
- encodedName? string - The encoded name of the field, which can be used directly in a JQL query
- 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
- path string - The path in the property value to query
- 'type? "number"|"string"|"text"|"date"|"user" - 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
- entity string - The object on which the property is set
- 'key string - The key of the property
jira: JqlQueryOrderByClause
Closed record
Details of the order-by JQL clause
Fields
- fields JqlQueryOrderByClauseElement[] - The list of order-by clause fields and their ordering directives
jira: JqlQueryOrderByClauseElement
Closed record
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? "asc"|"desc" - The direction in which to order the results
jira: JqlQueryToSanitize
Closed record
The JQL query to sanitize for the account ID. If the account ID is null, sanitizing is performed for an anonymous user
Fields
- accountId? string? - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5
- query string - The query to sanitize
jira: JQLQueryWithUnknownUsers
Closed record
JQL queries that contained users that could not be found
Fields
- convertedQuery? string - The converted query, with accountIDs instead of user identifiers, or 'unknown' for users that could not be found
- originalQuery? string - The original query, for reference
jira: JQLReferenceData
Closed record
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: JsonContextVariable
A JSON object with custom content
Fields
- 'type string - Type of custom context variable
- value? record {} - A JSON object containing custom content
jira: JsonNode
Closed record
Fields
- valueAsDouble? decimal -
- numberType? "INT"|"LONG"|"BIG_INTEGER"|"FLOAT"|"DOUBLE"|"BIG_DECIMAL" -
- fieldNames? record {} -
- decimalValue? decimal -
- valueAsBoolean? boolean -
- valueNode? boolean -
- long? boolean -
- longValue? int -
- valueAsInt? Signed32 -
- missingNode? boolean -
- number? boolean -
- valueAsText? string -
- array? boolean -
- containerNode? boolean -
- numberValue? decimal -
- bigDecimal? boolean -
- valueAsLong? int -
- integralNumber? boolean -
- textValue? string -
- double? boolean -
- intValue? Signed32 -
- bigInteger? boolean -
- doubleValue? decimal -
- floatingPointNumber? boolean -
- 'int? boolean -
- textual? boolean -
- pojo? boolean -
- bigIntegerValue? int -
- 'boolean? boolean -
- 'null? boolean -
- binary? boolean -
- elements? record {} -
- booleanValue? boolean -
- fields? record {} -
- binaryValue? string[] -
- 'object? boolean -
jira: JsonTypeBean
Closed record
The schema of a field
Fields
- system? string - If the field is a system field, the name of the field
- configuration? record {} - If the field is a custom field, the configuration of the field
- custom? string - If the field is a custom field, the URI of the field
- 'type string - The data type of the field
- customId? int - If the field is a custom field, the custom ID of the field
- items? string - When the data type is an array, the name of the field items within the array
jira: KeywordOperand
An operand that is a JQL keyword. See Advanced searching - keywords reference for more information about operand keywords
Fields
- keyword "empty" - The keyword that is the operand value
jira: License
Closed record
Details about a license for the Jira instance
Fields
- applications LicensedApplication[] - The applications under this license
jira: LicensedApplication
Closed record
Details about a licensed Jira application
Fields
- id string - The ID of the application
- plan "UNLICENSED"|"FREE"|"PAID" - The licensing plan
jira: LicenseMetric
Closed record
A metric that provides insight into the active licence details
Fields
- value? string - The calculated value of a licence metric linked to the key. An example licence metric is the approximate number of user accounts
- 'key? string - The key of a specific license metric
jira: LinkedIssue
Closed record
The ID or key of a linked issue
Fields
- self? string - The URL of the issue
- id? string - The ID of an issue. Required if
keyisn't provided
- fields? Fields1 - The fields associated with the issue
- 'key? string - The key of an issue. Required if
idisn't provided
jira: LinkGroup
Closed record
Details a link group, which defines issue operations
Fields
- groups? LinkGroup[] -
- header? SimpleLink - Details about the operations available in this version
- weight? Signed32 -
- links? SimpleLink[] -
- id? string -
- styleClass? string -
jira: LinkIssueRequestJsonBean
Closed record
Fields
- outwardIssue LinkedIssue - The ID or key of a linked issue
- comment? Comment - A comment
- inwardIssue LinkedIssue - The ID or key of a linked issue
- '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
jira: ListOperand
An operand that is a list of values
Fields
- encodedOperand? string - Encoded operand, which can be used directly in a JQL query
- values JqlQueryUnitaryOperand[] - The list of operand values
jira: ListWrapperCallbackApplicationRole
Closed record
jira: ListWrapperCallbackGroupName
Closed record
jira: Locale
Closed record
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: MappingsByIssueTypeOverride
Closed record
Overrides, for the selected issue types, any status mappings provided in statusMappingsByWorkflows. Status mappings are required when the new workflow for an issue type doesn't contain all statuses that the old workflow has. Status mappings can be provided by a combination of statusMappingsByWorkflows and statusMappingsByIssueTypeOverride
Fields
- issueTypeId string - The ID of the issue type for this mapping
- statusMappings WorkflowAssociationStatusMapping[] - The list of status mappings
jira: MappingsByWorkflow
Closed record
The status mappings by workflows. Status mappings are required when the new workflow for an issue type doesn't contain all statuses that the old workflow has. Status mappings can be provided by a combination of statusMappingsByWorkflows and statusMappingsByIssueTypeOverride
Fields
- newWorkflowId string - The ID of the new workflow
- statusMappings WorkflowAssociationStatusMapping[] - The list of status mappings
- oldWorkflowId string - The ID of the old workflow
jira: MigrationResourceUpdateEntityPropertiesValuePutHeaders
Represents the Headers record for the operation: MigrationResource.updateEntityPropertiesValue_put
Fields
- atlassianTransferId string - The app migration transfer ID
jira: MigrationResourceWorkflowRuleSearchPostHeaders
Represents the Headers record for the operation: MigrationResource.workflowRuleSearch_post
Fields
- atlassianTransferId string - The app migration transfer ID
jira: MoveFieldBean
Closed record
Fields
- after? string - The ID of the screen tab field after which to place the moved screen tab field. Required if
positionisn't provided
- position? "Earlier"|"Later"|"First"|"Last" - The named position to which the screen tab field should be moved. Required if
afterisn't provided
jira: MultiIssueEntityProperties
Closed record
A list of issues and their respective properties to set or update. See Entity properties for more information
Fields
- issues? IssueEntityPropertiesForMultiUpdate[] - A list of issue IDs and their respective properties
jira: MultipartFile
Closed record
Fields
- size? int -
- 'resource? Resource -
- bytes? string[] -
- name? string -
- inputStream? record {} -
- contentType? string -
- originalFilename? string -
- empty? boolean -
jira: MultipleCustomFieldValuesUpdate
Closed record
A custom field and its new value with a list of issue to update
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:
stringthe value must be a string.numberthe value must be a number.datetimethe value must be a string that represents a date in the ISO format or the simplified extended ISO format. For example,"2023-01-18T12:00:00-03:00"or"2023-01-18T12:00:00.000Z". However, the milliseconds part is ignored.userthe value must be an object that contains theaccountIdfield.groupthe value must be an object that contains the groupnameorgroupIdfield. Because group names can change, we recommend usinggroupId.
listcollection type
- customField string - The ID or key of the custom field. For example,
customfield_10010
jira: MultipleCustomFieldValuesUpdateDetails
Closed record
List of updates for a custom fields
Fields
- updates? MultipleCustomFieldValuesUpdate[] -
jira: NestedResponse
Closed record
Fields
- warningCollection? WarningCollection -
- errorCollection? ErrorCollection - Error messages from an operation
- status? Signed32 -
jira: NewUserDetails
The user details
Fields
- applicationKeys? string[] - Deprecated, do not use.
- displayName? string - This property is no longer available. If the user has an Atlassian account, their display name 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.
- 'key? string - This property is no longer available. See the migration guide for details.
- name? string - This property is no longer available. See the migration guide for details.
- password? string - This property 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.
- products string[] - Products the new user has access to. Valid products are: jira-core, jira-servicedesk, jira-product-discovery, jira-software. To create a user without product access, set this field to be an empty array.
- self? string - The URL of the user.
jira: NonWorkingDay
Closed record
Fields
- iso8601Date? string -
- id? int -
jira: Notification
Details about a notification
Fields
- htmlBody? string - The HTML body of the email notification for the issue.
- restrict? NotificationRecipientsRestrictions - Restricts the notifications to users with the specified permissions.
- 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.
- to? NotificationRecipients - The recipients of the email notification for the issue.
jira: NotificationEvent
Closed record
Details about a notification event
Fields
- templateEvent? NotificationEvent - The template of the event. Only custom events configured by Jira administrators have template
- name? string - The name of the event
- description? string - The description of the event
- id? int - The ID of the event. The event can be a Jira system event or a custom event
jira: NotificationRecipients
Details of the users and groups to receive the notification
Fields
- assignee? boolean - Whether the notification should be sent to the issue's assignees.
- groupIds? string[] - List of groupIds to receive the notification.
- groups? GroupName[] - List of groups to receive the notification.
- reporter? boolean - Whether the notification should be sent to the issue's reporter.
- users? UserDetails[] - List of users to receive the notification.
- voters? boolean - Whether the notification should be sent to the issue's voters.
- watchers? boolean - Whether the notification should be sent to the issue's watchers.
jira: NotificationRecipientsRestrictions
Closed record
Details of the group membership or permissions needed to receive the notification
Fields
- permissions? RestrictedPermission[] - List of permissions required to receive the notification
- groupIds? string[] - List of groupId memberships required to receive the notification
- groups? GroupName[] - List of group memberships required to receive the notification
jira: NotificationScheme
Closed record
Details about a notification scheme
Fields
- expand? string - Expand options that include additional notification scheme details in the response
- projects? int[] - The list of project IDs associated with the notification scheme
- scope? Scope - The scope of the notification scheme
- name? string - The name of the notification scheme
- description? string - The description of the notification scheme
- self? string -
- id? int - The ID of the notification scheme
- notificationSchemeEvents? NotificationSchemeEvent[] - The notification events and associated recipients
jira: NotificationSchemeAndProjectMappingJsonBean
Closed record
Fields
- notificationSchemeId? string -
- projectId? string -
jira: NotificationSchemeEvent
Closed record
Details about a notification scheme event
Fields
- event? NotificationEvent - Details about a notification event
- notifications? EventNotification[] -
jira: NotificationSchemeEventDetails
Details of a notification scheme event
Fields
- event NotificationSchemeEventTypeId - The ID of the event.
- notifications NotificationSchemeNotificationDetails[] - The list of notifications mapped to a specified event.
jira: NotificationSchemeEventIDPayload
Closed record
The event ID to use for reference in the payload
Fields
- id? string - The event ID to use for reference in the payload
jira: NotificationSchemeEventPayload
Closed record
The payload for creating a notification scheme event. Defines which notifications should be sent for a specific event
Fields
- event? NotificationSchemeEventIDPayload - The event ID to use for reference in the payload
- notifications? NotificationSchemeNotificationDetailsPayload[] - The configuration for notification recipents
jira: NotificationSchemeEventTypeId
The ID of an event that is being mapped to notifications
Fields
- id string - The ID of the notification scheme event.
jira: NotificationSchemeId
The ID of a notification scheme
Fields
- id string - The ID of a notification scheme.
jira: NotificationSchemeNotificationDetails
Details of a notification within a notification scheme
Fields
- notificationType string - The notification type, e.g
CurrentAssignee,Group,EmailAddress.
- 'parameter? string - The value corresponding to the specified notification type.
jira: NotificationSchemeNotificationDetailsPayload
Closed record
The configuration for notification recipents
Fields
- 'parameter? string - The parameter of the notification, should be eiither null if not required, or PCRI
- notificationType? string - The type of notification
jira: NotificationSchemePayload
Closed record
The payload for creating a notification scheme. The user has to supply the ID for the default notification scheme. For CMP this is provided in the project payload and should be left empty, for TMP it's provided using this payload
Fields
- onConflict? "FAIL"|"USE"|"NEW" - The strategy to use when there is a conflict with an existing entity
- name? string - The name of the notification scheme
- description? string - The description of the notification scheme
- notificationSchemeEvents? NotificationSchemeEventPayload[] - The events and notifications for the notification scheme
- pcri? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
jira: OAuth2RefreshTokenGrantConfig
Closed record
OAuth2 Refresh Token Grant Configs
Fields
- Fields Included from *OAuth2RefreshTokenGrantConfig
- refreshUrl string(default "https://auth.atlassian.com/oauth/token") - Refresh URL
jira: OldToNewSecurityLevelMappingsBean
Closed record
Fields
- newLevelId string - The new issue security level ID. Providing null will clear the assigned old level from issues
- oldLevelId string - The old issue security level ID. Providing null will remap all issues without any assigned levels
jira: OperationMessage
Closed record
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
Closed record
An ordered list of custom field option IDs and information on where to move them
Fields
- after? string - The ID of the custom field option or cascading option to place the moved options after. Required if
positionisn't provided
- position? "First"|"Last" - The position the custom field options should be moved to. Required if
afterisn't provided
- 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
jira: OrderOfIssueTypes
Closed record
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
positionisn't provided
- position? "First"|"Last" - The position the issue types should be moved to. Required if
afterisn't provided
jira: PageBean2ComponentJsonBean
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? ComponentJsonBean[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBean2JqlFunctionPrecomputationBean
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? JqlFunctionPrecomputationBean[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanBulkContextualConfiguration
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? BulkContextualConfiguration[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanChangelog
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? Changelog[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanComment
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? Comment[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanComponentWithIssueCount
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? ComponentWithIssueCount[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanContext
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? Context[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanContextForProjectAndIssueType
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? ContextForProjectAndIssueType[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanContextualConfiguration
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? ContextualConfiguration[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanCustomFieldContext
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? CustomFieldContext[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanCustomFieldContextDefaultValue
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? CustomFieldContextDefaultValue[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanCustomFieldContextOption
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? CustomFieldContextOption[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanCustomFieldContextProjectMapping
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? CustomFieldContextProjectMapping[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanDashboard
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? Dashboard[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanField
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? Field[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanFieldConfigurationDetails
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? FieldConfigurationDetails[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanFieldConfigurationIssueTypeItem
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? FieldConfigurationIssueTypeItem[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanFieldConfigurationItem
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? FieldConfigurationItem[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanFieldConfigurationScheme
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? FieldConfigurationScheme[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanFieldConfigurationSchemeProjects
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? FieldConfigurationSchemeProjects[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanFilterDetails
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? FilterDetails[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanGroupDetails
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? GroupDetails[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanIssueFieldOption
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? IssueFieldOption[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanIssueSecurityLevelMember
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? IssueSecurityLevelMember[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanIssueSecuritySchemeToProjectMapping
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? IssueSecuritySchemeToProjectMapping[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanIssueTypeScheme
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? IssueTypeScheme[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanIssueTypeSchemeMapping
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? IssueTypeSchemeMapping[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanIssueTypeSchemeProjects
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? IssueTypeSchemeProjects[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanIssueTypeScreenScheme
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? IssueTypeScreenScheme[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanIssueTypeScreenSchemeItem
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? IssueTypeScreenSchemeItem[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanIssueTypeScreenSchemesProjects
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? IssueTypeScreenSchemesProjects[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanIssueTypeToContextMapping
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? IssueTypeToContextMapping[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanNotificationScheme
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? NotificationScheme[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanNotificationSchemeAndProjectMappingJsonBean
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? NotificationSchemeAndProjectMappingJsonBean[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanPriority
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? Priority[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanPrioritySchemeWithPaginatedPrioritiesAndProjects
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? PrioritySchemeWithPaginatedPrioritiesAndProjects[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanPriorityWithSequence
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? PriorityWithSequence[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanProject
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? Project[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanProjectDetails
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? ProjectDetails[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanResolutionJsonBean
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? ResolutionJsonBean[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanScreen
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? Screen[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanScreenScheme
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? ScreenScheme[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanScreenWithTab
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? ScreenWithTab[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanSecurityLevel
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? SecurityLevel[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanSecurityLevelMember
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? SecurityLevelMember[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanSecuritySchemeWithProjects
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? SecuritySchemeWithProjects[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanString
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? string[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanUiModificationDetails
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? UiModificationDetails[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanUser
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? User[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanUserDetails
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? UserDetails[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanUserKey
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? UserKey[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanVersion
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? Version[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanWebhook
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? Webhook[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanWorkflow
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? Workflow[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanWorkflowScheme
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? WorkflowScheme[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PageBeanWorkflowTransitionRules
Closed record
A page of items
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? WorkflowTransitionRules[] - The list of items
- self? string - The URL of the page
- startAt? int - The index of the first item returned
jira: PagedListUserDetailsApplicationUser
Closed record
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? Signed32 - The number of items on the page
- endIndex? Signed32 - The index of the last item returned on the page
- maxResults? Signed32 - The maximum number of results that could be on the page
- startIndex? Signed32 - The index of the first item returned on the page
- items? UserDetails[] - The list of items
jira: PageOfChangelogs
Closed record
A page of changelogs
Fields
- total? Signed32 - The number of results on the page
- maxResults? Signed32 - The maximum number of results that could be on the page
- histories? Changelog[] - The list of changelogs
- startAt? Signed32 - The index of the first item returned on the page
jira: PageOfComments
A page of comments
Fields
- comments? Comment[] - The list of comments.
- maxResults? Signed32 - 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.
jira: PageOfCreateMetaIssueTypes
A page of CreateMetaIssueTypes
Fields
- createMetaIssueType? IssueTypeIssueCreateMetadata[] -
- issueTypes? IssueTypeIssueCreateMetadata[] - The list of CreateMetaIssueType.
- maxResults? Signed32 - The maximum number of items to return per page.
- startAt? int - The index of the first item returned.
- total? int - The total number of items in all pages.
jira: PageOfCreateMetaIssueTypeWithField
A page of CreateMetaIssueType with Field
Fields
- fields? FieldCreateMetadata[] - The collection of FieldCreateMetaBeans.
- maxResults? Signed32 - The maximum number of items to return per page.
- results? FieldCreateMetadata[] -
- startAt? int - The index of the first item returned.
- total? int - The total number of items in all pages.
jira: PageOfDashboards
Closed record
A page containing dashboard details
Fields
- next? string - The URL of the next page of results, if any
- total? Signed32 - The number of results on the page
- maxResults? Signed32 - The maximum number of results that could be on the page
- prev? string - The URL of the previous page of results, if any
- dashboards? Dashboard[] - List of dashboards
- startAt? Signed32 - The index of the first item returned on the page
jira: PageOfStatuses
Closed record
Fields
- total? int - Number of items that satisfy the search
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - The URL of the next page of results, if any
- values? JiraStatus[] - The list of items
- self? string - The URL of this page
- startAt? int - The index of the first item returned on the page
jira: PageOfWorklogs
Paginated list of worklog details
Fields
- maxResults? Signed32 - The maximum number of results that could be on the page.
- startAt? Signed32 - The index of the first item returned on the page.
- total? Signed32 - The number of results on the page.
- worklogs? Worklog[] - List of worklogs.
jira: PageWithCursorGetPlanResponseForPage
Closed record
Fields
- cursor? string -
- total? int -
- last? boolean -
- size? Signed32 -
- nextPageCursor? string -
- values? GetPlanResponseForPage[] -
jira: PageWithCursorGetTeamResponseForPage
Closed record
Fields
- cursor? string -
- total? int -
- last? boolean -
- size? Signed32 -
- nextPageCursor? string -
- values? GetTeamResponseForPage[] -
jira: ParsedJqlQueries
Closed record
A list of parsed JQL queries
Fields
- queries ParsedJqlQuery[] - A list of parsed JQL queries
jira: ParsedJqlQuery
Closed record
Details of a parsed JQL query
Fields
- query string - The JQL query that was parsed and validated
- warnings? string[] - The list of warning messages
- errors? string[] - The list of syntax or validation errors
- structure? JqlQuery - The syntax tree of the query. Empty if the query was invalid
jira: ParseJqlQueriesQueries
Represents the Queries record for the operation: parseJqlQueries
Fields
- validation "strict"|"warn"|"none" (default "strict") - How to validate the JQL query and treat the validation results. Validation options include:
strictReturns all errors. If validation fails, the query structure is not returned.warnReturns all errors. If validation fails but the JQL query is correctly formed, the query structure is returned.noneNo validation is performed. If JQL query is correctly formed, the query structure is returned
jira: PermissionDetails
Closed record
Details for permissions of shareable entities
Fields
- editPermissions SharePermission[] - The edit permissions for the shareable entities
jira: PermissionGrant
Details about a permission granted to a user or group
Fields
- holder? PermissionHolder - The user or group being granted the permission. It consists of a
type, a type-dependentparameterand a type-dependentvalue. See Holder object in Get all permission schemes for more information.
- id? int - The ID of the permission granted details.
- 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.
- self? string - The URL of the permission granted details.
jira: PermissionGrantDTO
Closed record
List of permission grants
Fields
- permissionKeys? string[] -
- groupCustomFields? ProjectCreateResourceIdentifier[] -
- projectRoles? ProjectCreateResourceIdentifier[] -
- specialGrants? string[] -
- groups? ProjectCreateResourceIdentifier[] -
- userCustomFields? ProjectCreateResourceIdentifier[] -
- users? ProjectCreateResourceIdentifier[] -
- applicationAccess? string[] -
jira: PermissionGrants
Closed record
List of permission grants
Fields
- expand? string - Expand options that include additional permission grant details in the response
- permissions? PermissionGrant[] - Permission grants list
jira: PermissionHolder
Closed record
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
- expand? string - Expand options that include additional permission holder details in the response
- 'parameter? string - As a group's name can change, use of
valueis recommended. The identifier associated withthetypevalue that defines the holder of the permission
- 'type string - The type of permission holder
- value? string - The identifier associated with the
typevalue that defines the holder of the permission
jira: PermissionPayloadDTO
Closed record
The payload to create a permission scheme
Fields
- grants? PermissionGrantDTO[] - List of permission grants
- onConflict "FAIL"|"USE"|"NEW" (default "FAIL") - The strategy to use when there is a conflict with an existing permission scheme. FAIL - Fail execution, this always needs to be unique; USE - Use the existing entity and ignore new entity parameters; NEW - If the entity exist, try and create a new one with a different name
- name? string - The name of the permission scheme
- description? string - The description of the permission scheme
- addAddonRole? boolean - Configuration to generate addon role. Default is false if null
- pcri? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
jira: Permissions
Closed record
Details about permissions
Fields
- permissions? record { UserPermission... } - List of permissions
jira: PermissionScheme
Details of a permission scheme
Fields
- description? string - A description for the permission scheme.
- expand? string - The expand options available for the permission scheme.
- id? int - The ID of the permission scheme.
- name string - The name of the permission scheme. Must be unique.
- permissions? PermissionGrant[] - The permission scheme to create or update. See About permission schemes and grants for more information.
- scope? Scope - The scope of the permission scheme.
- self? string - The URL of the permission scheme.
jira: PermissionSchemes
Closed record
List of all permission schemes
Fields
- permissionSchemes? PermissionScheme[] - Permission schemes list
jira: PermissionsKeysBean
Closed record
Fields
- permissions string[] - A list of permission keys
jira: PermittedProjects
Closed record
A list of projects in which a user is granted permissions
Fields
- projects? ProjectIdentifierBean[] - A list of projects
jira: Priority
An issue priority
Fields
- avatarId? int - The avatarId of the avatar for the issue priority. This parameter is nullable and when set, this avatar references the universal avatar APIs.
- description? string - The description of the issue priority.
- iconUrl? string - The URL of the icon for the issue priority.
- id? string - The ID of the issue priority.
- isDefault? boolean - Whether this priority is the default.
- name? string - The name of the issue priority.
- schemes? ExpandPrioritySchemePage - Priority schemes associated with the issue priority.
- self? string - The URL of the issue priority.
- statusColor? string - The color used to indicate the issue priority.
jira: PriorityId
The ID of an issue priority
Fields
- id string - The ID of the issue priority.
jira: PriorityMapping
Closed record
Mapping of issue priorities for changes in priority schemes
Fields
- 'in? record { int... } - The mapping of priorities for issues being migrated into this priority scheme. Key is the old priority ID, value is the new priority ID (must exist in this priority scheme).
E.g. The current priority scheme has priority ID
10001. Issues with priority ID10000are being migrated into this priority scheme will need mapping to new priorities. Theinmapping would be{"10000": 10001}
- out? record { int... } - The mapping of priorities for issues being migrated out of this priority scheme. Key is the old priority ID (must exist in this priority scheme), value is the new priority ID (must exist in the default priority scheme). Required for updating an existing priority scheme. Not used when creating a new priority scheme.
E.g. The current priority scheme has priority ID
10001. Issues with priority ID10001are being migrated out of this priority scheme will need mapping to new priorities. Theoutmapping would be{"10001": 10000}
jira: PrioritySchemeChangesWithoutMappings
Closed record
Fields
- ids int[] - Affected entity ids
jira: PrioritySchemeId
Closed record
The ID of a priority scheme
Fields
- task? TaskProgressBeanJsonNode - The in-progress issue migration task
- id? string - The ID of the priority scheme
jira: PrioritySchemeWithPaginatedPrioritiesAndProjects
A priority scheme with paginated priorities and projects
Fields
- default? boolean -
- defaultPriorityId? string - The ID of the default issue priority.
- description? string - The description of the priority scheme
- id string - The ID of the priority scheme.
- isDefault? boolean -
- name string - The name of the priority scheme
- priorities? PageBeanPriorityWithSequence - The paginated list of priorities.
- projects? PageBeanProjectDetails - The paginated list of projects.
- self? string - The URL of the priority scheme.
jira: PriorityWithSequence
Closed record
An issue priority with sequence information
Fields
- sequence? string - The sequence of the issue priority
- isDefault? boolean - Whether this priority is the default
- statusColor? string - The color used to indicate the issue priority
- name? string - The name of the issue priority
- description? string - The description of the issue priority
- self? string - The URL of the issue priority
- iconUrl? string - The URL of the icon for the issue priority
- id? string - The ID of the issue priority
jira: Project
Closed record
Details about a project
Fields
- components? ProjectComponent[] - List of the components contained in the project
- roles? record { string... } - The name and self URL for each role defined in the project. For more information, see Create project role
- description? string - A brief description of the project
- isPrivate? boolean - Whether the project is private from the user's perspective. This means the user can't see the project or any associated issues
- uuid? string - Unique ID for next-gen projects
- deletedBy? User - The user who marked the project as deleted
- issueTypes? IssueTypeDetails[] - List of the issue types available in the project
- archived? boolean - Whether the project is archived
- permissions? ProjectPermissions - User permissions on the project
- projectCategory? ProjectCategory - The category the project belongs to
- assigneeType? "PROJECT_LEAD"|"UNASSIGNED" - The default assignee when creating issues for this project
- id? string - The ID of the project
- archivedBy? User - The user who archived the project
- projectTypeKey? "software"|"service_desk"|"business" - The project type of the project
- email? string - An email address associated with the project
- 'key? string - The key of the project
- archivedDate? string - The date when the project was archived
- retentionTillDate? string - The date when the project is deleted permanently
- avatarUrls? AvatarUrlsBean - The URLs of the project's avatars
- landingPageInfo? ProjectLandingPageInfo - The project landing page info
- favourite? boolean - Whether the project is selected as a favorite
- lead? User - The username of the project lead
- url? string - A link to information about this project, such as project documentation
- insight? ProjectInsight - Insights about the project
- expand? string - Expand options that include additional project details in the response
- deleted? boolean - Whether the project is marked as deleted
- simplified? boolean - Whether the project is simplified
- deletedDate? string - The date when the project was marked as deleted
- versions? Version[] - The versions defined in the project. For more information, see Create version
- issueTypeHierarchy? Hierarchy - The issue type hierarchy for the project
- name? string - The name of the project
- self? string - The URL of the project details
- style? "classic"|"next-gen" - The type of the project
- properties? record {} - Map of project properties
jira: ProjectAndIssueTypePair
Closed record
A project and issueType ID pair that identifies a status mapping
Fields
- issueTypeId string - The ID of the issue type
- projectId string - The ID of the project
jira: ProjectAvatars
Closed record
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
Closed record
A project category
Fields
- name? string - The name of the project category. Required on create, optional on update
- description? string - The description of the project category
- self? string - The URL of the project category
- id? string - The ID of the project category
jira: ProjectComponent
Closed record
Details about a project component
Fields
- leadUserName? string - This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details
- metadata? record { string... } - Compass component's metadata. Can't be updated. Not required for creating a Project Component
- description? string - The description for the component. Optional when creating or updating a component
- project? string - The key of the project the component is assigned to. Required when creating a component. Can't be updated
- leadAccountId? string - The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5
- lead? User - The user details for the component's lead user
- isAssigneeTypeValid? boolean - Whether a user is associated with
assigneeType. For example, if theassigneeTypeis set toCOMPONENT_LEADbut the component lead is not set, thenfalseis returned
- realAssigneeType? "PROJECT_DEFAULT"|"COMPONENT_LEAD"|"PROJECT_LEAD"|"UNASSIGNED" - 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,assigneeTypeis set toCOMPONENT_LEADbut no component lead is set. This property is set to one of the following values:PROJECT_LEADwhenassigneeTypeisPROJECT_LEADand the project lead has permission to be assigned issues in the project that the component is in.COMPONENT_LEADwhenassigneeType isCOMPONENT_LEADand the component lead has permission to be assigned issues in the project that the component is in.UNASSIGNEDwhenassigneeTypeisUNASSIGNEDand Jira is configured to allow unassigned issues.PROJECT_DEFAULTwhen none of the preceding cases are true
- 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
- ari? string - Compass component's ID. Can't be updated. Not required for creating a Project Component
- self? string - The URL of the component
- realAssignee? User - The user assigned to issues created with this component, when
assigneeTypedoes not identify a valid assignee
- assignee? User - The details of the user associated with
assigneeType, if any. SeerealAssigneefor details of the user assigned to issues created with this component
- assigneeType? "PROJECT_DEFAULT"|"COMPONENT_LEAD"|"PROJECT_LEAD"|"UNASSIGNED" - The nominal user type used to determine the assignee for issues created with this component. See
realAssigneeTypefor details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values:PROJECT_LEADthe assignee to any issues created with this component is nominally the lead for the project the component is in.COMPONENT_LEADthe assignee to any issues created with this component is nominally the lead for the component.UNASSIGNEDan assignee is not set for issues created with this component.PROJECT_DEFAULTthe assignee to any issues created with this component is nominally the default assignee for the project that the component is in.
PROJECT_DEFAULT.
Optional when creating or updating a component
- id? string - The unique identifier for the component
- projectId? int - The ID of the project the component is assigned to
jira: ProjectCreateResourceIdentifier
Closed record
Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either id - The ID of an entity that already exists in the target site, or ref - A unique reference to an entity that is being created entityId - entity identifier, if type is id - must be an existing entity ID that exists in the Jira site, if ref - must be unique across all entities in the scope of this project template creation
Fields
- anID? boolean -
- areference? boolean -
- entityType? string -
- entityId? string -
- id? string -
- 'type? "id"|"ref" -
jira: ProjectCustomTemplateCreateRequestDTO
Closed record
Request to create a project using a custom template
Fields
- template? CustomTemplateRequestDTO - The specific request object for creating a project with template
- details? CustomTemplatesProjectDetails - Project Details
jira: ProjectDataPolicies
Closed record
Details about data policies for a list of projects
Fields
- projectDataPolicies? ProjectWithDataPolicy[] - List of projects with data policies
jira: ProjectDataPolicy
Closed record
Details about data policy
Fields
- anyContentBlocked? boolean - Whether the project contains any content inaccessible to the requesting application
jira: ProjectDetails
Closed record
Details about a project
Fields
- 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
- name? string - The name of the project
- self? string - The URL of the project details
- id? string - The ID of the project
- projectTypeKey? "software"|"service_desk"|"business" - The project type of the project
- 'key? string - The key of the project
jira: ProjectEmailAddress
Closed record
A project's sender email address
Fields
- emailAddress? string - The email address
- emailAddressStatus? string[] - When using a custom domain, the status of the email address
jira: ProjectFeature
Closed record
Details of a project feature
Fields
- prerequisites? string[] - List of keys of the features required to enable the feature
- imageUri? string - URI for the image representing the feature
- toggleLocked? boolean - Whether the state of the feature can be updated
- feature? string - The key of the feature
- localisedDescription? string - Localized display description for the feature
- localisedName? string - Localized display name for the feature
- state? "ENABLED"|"DISABLED"|"COMING_SOON" - The state of the feature. When updating the state of a feature, only ENABLED and DISABLED are supported. Responses can contain all values
- projectId? int - The ID of the project
jira: ProjectFeatureState
Closed record
Details of the feature state
Fields
- state? "ENABLED"|"DISABLED"|"COMING_SOON" - The feature state
jira: ProjectId
Closed record
Project ID details
Fields
- id string - The ID of the project
jira: ProjectIdentifierBean
Closed record
The identifiers for a project
Fields
- id? int - The ID of the project
- 'key? string - The key of the project
jira: ProjectIdentifiers
Closed record
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
Closed record
A list of project IDs
Fields
- projectIds string[] - The IDs of projects
jira: ProjectInsight
Closed record
Additional details about a project
Fields
- totalIssueCount? int - Total issue count
- lastIssueUpdateTime? string - The last issue update time
jira: ProjectIssueCreateMetadata
Closed record
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
- issuetypes? IssueTypeIssueCreateMetadata[] - List of the issue types supported by the project
- avatarUrls? AvatarUrlsBean - List of the project's avatars, returning the avatar size and associated URL
- name? string - The name of the project
- self? string - The URL of the project
- id? string - The ID of the project
- 'key? string - The key of the project
jira: ProjectIssueSecurityLevels
Closed record
List of issue level security items in a project
Fields
- levels SecurityLevel[] - Issue level security items list
jira: ProjectIssueTypeHierarchy
Closed record
The hierarchy of issue types within a project
Fields
- hierarchy? ProjectIssueTypesHierarchyLevel[] - Details of an issue type hierarchy level
- projectId? int - The ID of the project
jira: ProjectIssueTypeMapping
Closed record
The project and issue type mapping
Fields
- issueTypeId string - The ID of the issue type
- projectId string - The ID of the project
jira: ProjectIssueTypeMappings
Closed record
The project and issue type mappings
Fields
- mappings ProjectIssueTypeMapping[] - The project and issue type mappings
jira: ProjectIssueTypes
Closed record
Deprecated. See the deprecation notice for details.
Use the optional workflows.usages expand to get additional information about the projects and issue types associated with the requested workflows
Fields
- project? ProjectId? - Project ID details
- issueTypes? string[]? - IDs of the issue types
jira: ProjectIssueTypesHierarchyLevel
Closed record
Details of an issue type hierarchy level
Fields
- level? Signed32 - The level of the issue type hierarchy level
- name? string - The name of the issue type hierarchy level
- 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
- issueTypes? IssueTypeInfo[] - The list of issue types in the hierarchy level
jira: ProjectLandingPageInfo
Closed record
Fields
- queueCategory? string -
- queueId? int -
- projectKey? string -
- queueName? string -
- simplified? boolean -
- simpleBoard? boolean -
- projectType? string -
- boardId? int -
- attributes? record { string... } -
- boardName? string -
- url? string -
jira: ProjectPayload
Closed record
The payload for creating a project
Fields
- issueSecuritySchemeId? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
- notificationSchemeId? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
- permissionSchemeId? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
- issueTypeScreenSchemeId? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
- fieldLayoutSchemeId? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
- workflowSchemeId? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
- issueTypeSchemeId? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
- projectTypeKey? "software"|"business"|"service_desk"|"product_discovery" - 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
- pcri? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
jira: ProjectPermissions
Closed record
Permissions which a user has on a project
Fields
- canEdit? boolean - Whether the logged user can edit the project
jira: ProjectRole
Closed record
Details about the roles in a project
Fields
- actors? RoleActor[] - The list of users who act in this role
- default? boolean - Whether this role is the default role for the project
- roleConfigurable? boolean - Whether the roles are configurable for this project
- currentUserRole? boolean - Whether the calling user is part of this role
- scope? Scope - The scope of the role. Indicated for roles associated with next-gen projects
- name? string - The name of the project role
- admin? boolean - Whether this role is the admin role for the project
- description? string - The description of the project role
- self? string - The URL the project role details
- id? int - The ID of the project role
- translatedName? string - The translated name of the project role
jira: ProjectRoleActorsUpdateBean
Closed record
Fields
- categorisedActors? record { string[]... } - The actors to add to the project role.
Add groups using:
atlassian-group-role-actorand a list of group names.atlassian-group-role-actor-idand a list of group IDs.
atlassian-group-role-actor-idis recommended. For example,"atlassian-group-role-actor-id":["eef79f81-0b89-4fca-a736-4be531a10869","77f6ab39-e755-4570-a6ae-2d7a8df0bcb8"]. Add users usingatlassian-user-role-actorand a list of account IDs. For example,"atlassian-user-role-actor":["12345678-9abc-def1-2345-6789abcdef12", "abcdef12-3456-789a-bcde-f123456789ab"]
- id? int - The ID of the project role. Use Get all project roles to get a list of project role IDs
jira: ProjectRoleDetails
Closed record
Details about a project role
Fields
- default? boolean - Whether this role is the default role for the project
- roleConfigurable? boolean - Whether the roles are configurable for this project
- scope? Scope - The scope of the role. Indicated for roles associated with next-gen projects
- name? string - The name of the project role
- admin? boolean - Whether this role is the admin role for the project
- description? string - The description of the project role
- self? string - The URL the project role details
- id? int - The ID of the project role
- translatedName? string - The translated name of the project role
jira: ProjectRoleGroup
Closed record
Details of the group associated with the role
Fields
- displayName? string - The display name of the group
- groupId? string - The ID of the group
- name? string - The name of the group. As a group's name can change, use of
groupIdis recommended to identify the group
jira: ProjectRoleUser
Closed record
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
Closed record
Fields
- attributes? ("notSelectable"|"defaultValue")[] - 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
- id? int - The ID of the project that the option's behavior applies to
jira: ProjectType
Closed record
Details about a project type
Fields
- descriptionI18nKey? string - The key of the project type's description
- color? string - The color of the project type
- icon? string - The icon of the project type
- formattedKey? string - The formatted key of the project type
- 'key? string - The key of the project type
jira: ProjectUsage
Closed record
The project
Fields
- id? string - The project ID
jira: ProjectUsagePage
Closed record
A page of projects
Fields
- nextPageToken? string - Page token for the next page of project usages
- values? ProjectUsage[] - The list of projects
jira: ProjectWithDataPolicy
Closed record
Details about data policies for a project
Fields
- dataPolicy? ProjectDataPolicy - Data policy
- id? int - The project ID
jira: PropertyKey
Closed record
Property key details
Fields
- self? string - The URL of the property
- 'key? string - The key of the property
jira: PropertyKeys
Closed record
List of property keys
Fields
- keys? PropertyKey[] - Property key details
jira: PublishDraftWorkflowScheme
Closed record
Details about the status mappings for publishing a draft workflow scheme
Fields
- statusMappings? StatusMapping[] - Mappings of statuses to new statuses for issue types
jira: PublishDraftWorkflowSchemeQueries
Represents the Queries record for the operation: publishDraftWorkflowScheme
Fields
- validateOnly boolean(default false) - Whether the request only performs a validation
jira: PublishedWorkflowId
Closed record
Properties that identify a published workflow
Fields
- name string - The name of the workflow
- entityId? string - The entity ID of the workflow
jira: QuickFilterPayload
Closed record
The payload for defining quick filters
Fields
- jqlQuery? string - The jql query for the quick filter
- name? string - The name of the quick filter
- description? string - The description of the quick filter
jira: ReadWorkflowSchemesQueries
Represents the Queries record for the operation: readWorkflowSchemes
Fields
- expand? string - Deprecated. See the deprecation notice for details.
Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:
workflows.usagesReturns the project and issue types that each workflow in the workflow scheme is associated with
jira: ReadWorkflowsQueries
Represents the Queries record for the operation: readWorkflows
Fields
- expand? string - Deprecated. See the deprecation notice for details.
Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:
workflows.usagesReturns the project and issue types that each workflow is associated with.statuses.usagesReturns the project and issue types that each status is associated with
- useApprovalConfiguration boolean(default false) - Return the new field
approvalConfigurationinstead of the deprecated status properties for approval configuration
jira: RedactionJobStatusResponse
Closed record
Fields
- jobStatus? "PENDING"|"IN_PROGRESS"|"COMPLETED" -
- bulkRedactionResponse? BulkRedactionResponse -
jira: RedactionPosition
Closed record
Represents the position of the redaction
Fields
- expectedText string - The text which will be redacted, encoded using SHA256 hash and Base64 digest
- adfPointer? string - The ADF pointer indicating the position of the text to be redacted. This is only required when redacting from rich text(ADF) fields. For plain text fields, this field can be omitted
- 'from Signed32 - The start index(inclusive) for the redaction in specified content
- to Signed32 - The ending index(exclusive) for the redaction in specified content
jira: RegisteredWebhook
Closed record
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
Closed record
Details of an issue remote link
Fields
- application? Application - Details of the remote application the linked item is in
- globalId? string - The global ID of the link, such as the ID of the item on the remote system
- self? string - The URL of the link
- id? int - The ID of the link
- relationship? string - Description of the relationship between the issue and the linked item
- 'object? RemoteObject - Details of the item linked to
jira: RemoteIssueLinkIdentifies
Closed record
Details of the identifiers for a created or updated remote issue link
Fields
- self? string - The URL of the remote issue link
- id? int - The ID of the remote issue link, such as the ID of the item on the remote system
jira: RemoteIssueLinkRequest
Details of a remote issue link
Fields
- application? Application - Details of the remote application the linked item is in. For example, trello.
- 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.
- 'object RemoteObject - Details of the item linked to.
- 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.
jira: RemoteObject
The linked item
Fields
- 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.
- summary? string - The summary details of the item.
- title string - The title of the item.
- url string - The URL of the item.
jira: RemoveGroupQueries
Represents the Queries record for the operation: removeGroup
Fields
- swapGroupId? string - The ID of the group to transfer restrictions to. Only comments and worklogs are transferred. If restrictions are not transferred, comments and worklogs are inaccessible after the deletion. This parameter cannot be used with the
swapGroupparameter
- groupId? string - The ID of the group. This parameter cannot be used with the
groupnameparameter
- groupname? string -
- swapGroup? string - As a group's name can change, use of
swapGroupIdis recommended to identify a group.
The group to transfer restrictions to. Only comments and worklogs are transferred. If restrictions are not transferred, comments and worklogs are inaccessible after the deletion. This parameter cannot be used with theswapGroupIdparameter
jira: RemoveLevelQueries
Represents the Queries record for the operation: removeLevel
Fields
- replaceWith? string - The ID of the issue security level that will replace the currently selected level
jira: RemovePreferenceQueries
Represents the Queries record for the operation: removePreference
Fields
- 'key string - The key of the preference
jira: RemoveUserFromGroupQueries
Represents the Queries record for the operation: removeUserFromGroup
Fields
- accountId string - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5
- groupId? string - The ID of the group. This parameter cannot be used with the
groupNameparameter
- groupname? string - As a group's name can change, use of
groupIdis recommended to identify a group.
The name of the group. This parameter cannot be used with thegroupIdparameter
- username? string - This parameter is no longer available. See the deprecation notice for details
jira: RemoveUserQueries
Represents the Queries record for the operation: removeUser
Fields
- accountId string - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5
- 'key? string - This parameter is no longer available. See the deprecation notice for details
- username? string - This parameter is no longer available. See the deprecation notice for details
jira: RemoveWatcherQueries
Represents the Queries record for the operation: removeWatcher
Fields
- accountId? string - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required
- username? string - This parameter is no longer available. See the deprecation notice for details
jira: ReorderIssuePriorities
Closed record
Change the order of issue priorities
Fields
- ids string[] - The list of issue IDs to be reordered. Cannot contain duplicates nor after ID
- after? string - The ID of the priority. Required if
positionisn't provided
- position? string - The position for issue priorities to be moved to. Required if
afterisn't provided
jira: ReorderIssueResolutionsRequest
Closed record
Change the order of issue resolutions
Fields
- ids string[] - The list of resolution IDs to be reordered. Cannot contain duplicates nor after ID
- after? string - The ID of the resolution. Required if
positionisn't provided
- position? string - The position for issue resolutions to be moved to. Required if
afterisn't provided
jira: ReplaceCustomFieldOptionQueries
Represents the Queries record for the operation: replaceCustomFieldOption
Fields
- jql? string - A JQL query that specifies the issues to be updated. For example, project=10000
- replaceWith? int - The ID of the option that will replace the currently selected option
jira: ReplaceIssueFieldOptionQueries
Represents the Queries record for the operation: replaceIssueFieldOption
Fields
- jql? string - A JQL query that specifies the issues to be updated. For example, project=10000
- overrideScreenSecurity boolean(default false) - Whether screen security is overridden to enable hidden fields to be edited. Available to Connect and Forge app users with admin permission
- overrideEditableFlag boolean(default false) - Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect and Forge app users with Administer Jira global permission
- replaceWith? int - The ID of the option that will replace the currently selected option
jira: RequiredMappingByIssueType
Closed record
The list of required status mappings by issue type
Fields
- issueTypeId? string - The ID of the issue type
- statusIds? string[] - The status IDs requiring mapping
jira: RequiredMappingByWorkflows
Closed record
The list of required status mappings by workflow
Fields
- sourceWorkflowId? string - The ID of the source workflow
- statusIds? string[] - The status IDs requiring mapping
- targetWorkflowId? string - The ID of the target workflow
jira: ResetUserColumnsQueries
Represents the Queries record for the operation: resetUserColumns
Fields
- accountId? string - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5
- username? string - This parameter is no longer available. See the deprecation notice for details
jira: Resolution
Closed record
Details of an issue resolution
Fields
- name? string - The name of the issue resolution
- description? string - The description of the issue resolution
- self? string - The URL of the issue resolution
- id? string - The ID of the issue resolution
jira: ResolutionId
The ID of an issue resolution
Fields
- id string - The ID of the issue resolution.
jira: ResolutionJsonBean
Closed record
Fields
- default? boolean -
- name? string -
- description? string -
- self? string -
- iconUrl? string -
- id? string -
jira: Resource
Closed record
Fields
- readable? boolean -
- file? record { fileContent byte[], fileName string } -
- filename? string -
- description? string -
- inputStream? record {} -
- uri? string -
- open? boolean -
- url? string -
jira: RestrictedPermission
Details of the permission
Fields
- id? string - The ID of the permission. Either
idorkeymust be specified. Use Get all permissions to get the list of permissions.
- 'key? string - The key of the permission. Either
idorkeymust be specified. Use Get all permissions to get the list of permissions.
jira: RoleActor
Closed record
Details about a user assigned to a project role
Fields
- avatarUrl? string - The avatar 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
- actorGroup? ProjectRoleGroup -
- name? string - This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details
- id? int - The ID of the role actor
- 'type? "atlassian-group-role-actor"|"atlassian-user-role-actor" - The type of role actor
- actorUser? ProjectRoleUser -
jira: RolePayload
Closed record
The payload used to create a project role. It is optional for CMP projects, as a default role actor will be provided. TMP will add new role actors to the table
Fields
- onConflict "FAIL"|"USE"|"NEW" (default "USE") - The strategy to use when there is a conflict with an existing project role. FAIL - Fail execution, this always needs to be unique; USE - Use the existing entity and ignore new entity parameters
- name? string - The name of the role
- description? string - The description of the role
- defaultActors? ProjectCreateResourceIdentifier[] - The default actors for the role. By adding default actors, the role will be added to any future projects created
- 'type? "HIDDEN"|"VIEWABLE"|"EDITABLE" - The type of the role. Only used by project-scoped project
- pcri? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
jira: RolesCapabilityPayload
Closed record
Fields
- roles? RolePayload[] - The list of roles to create
- roleToProjectActors? record { ProjectCreateResourceIdentifier[]... } - A map of role PCRI (can be ID or REF) to a list of user or group PCRI IDs to associate with the role and project
jira: RuleConfiguration
Closed record
A rule configuration
Fields
- disabled boolean(default false) - Whether the rule is disabled
- tag? string - A tag used to filter rules in Get workflow transition rule configurations
- value string - Configuration of the rule, as it is stored by the Connect or the Forge app on the rule configuration page
jira: RulePayload
Closed record
The payload for creating rules in a workflow
Fields
- parameters? record { string... } - The parameters of the rule
- ruleKey? string - The key of the rule. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows/#api-rest-api-3-workflows-capabilities-get
jira: SanitizedJqlQueries
Closed record
The sanitized JQL queries for the given account IDs
Fields
- queries? SanitizedJqlQuery[] - The list of sanitized JQL queries
jira: SanitizedJqlQuery
Closed record
Details of the sanitized JQL query
Fields
- accountId? string? - The account ID of the user for whom sanitization was performed
- initialQuery? string - The initial query
- sanitizedQuery? string? - The sanitized query, if there were no errors
- errors? ErrorCollection - The list of errors
jira: Scope
The projects the item is associated with. Indicated for items associated with next-gen projects
Fields
- project? ProjectDetails - The project the item has scope in.
- 'type? "PROJECT"|"TEMPLATE" - The type of scope.
jira: ScopePayload
Closed record
The payload for creating a scope. Defines if a project is team-managed project or company-managed project
Fields
- 'type? "GLOBAL"|"PROJECT" - The type of the scope. Use
GLOBALor empty for company-managed project, andPROJECTfor team-managed project
jira: Screen
Closed record
A screen
Fields
- scope? Scope - The scope of the screen
- name? string - The name of the screen
- description? string - The description of the screen
- id? int - The ID of the screen
jira: ScreenableField
Closed record
A screen tab field
Fields
- name? string - The name of the screen tab field. Required on create and update. The maximum length is 255 characters
- id? string - The ID of the screen tab field
jira: ScreenableTab
Closed record
A screen tab
Fields
- name string - The name of the screen tab. The maximum length is 255 characters
- id? int - The ID of the screen tab
jira: ScreenDetails
Closed record
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: ScreenPayload
Closed record
Defines the payload for the field screens. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screens/\#api-rest-api-3-screens-post
Fields
- name? string - The name of the screen
- tabs? TabPayload[] - The tabs of the screen. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-tab-fields/#api-rest-api-3-screens-screenid-tabs-tabid-fields-post
- description? string - The description of the screen
- pcri? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
jira: ScreenScheme
Closed record
A screen scheme
Fields
- issueTypeScreenSchemes? PageBeanIssueTypeScreenScheme - Details of the issue type screen schemes associated with the screen scheme
- screens? ScreenTypes - The IDs of the screens for the screen types of the screen scheme
- name? string - The name of the screen scheme
- description? string - The description of the screen scheme
- id? int - The ID of the screen scheme
jira: ScreenSchemeDetails
Closed record
Details of a screen scheme
Fields
- screens ScreenTypes - The IDs of the screens for the screen types of the screen scheme. Only screens used in classic projects are accepted
- 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
jira: ScreenSchemeId
Closed record
The ID of a screen scheme
Fields
- id int - The ID of the screen scheme
jira: ScreenSchemePayload
Closed record
Defines the payload for the screen schemes. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-schemes/\#api-rest-api-3-screenscheme-post
Fields
- screens? record { ProjectCreateResourceIdentifier... } - Similar to the field layout scheme those mappings allow users to set different screens for different operations: default - always there, applied to all operations that don't have an explicit mapping
create,view,edit- specific operations that are available and users can assign a different screen for each one of them https://support.atlassian.com/jira-cloud-administration/docs/manage-screen-schemes/#Associating-a-screen-with-an-issue-operation
- defaultScreen? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
- name? string - The name of the screen scheme
- description? string - The description of the screen scheme
- pcri? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
jira: ScreenTypes
Closed record
The IDs of the screens for the screen types of the screen scheme
Fields
- default int - The ID of the default screen. Required when creating a screen scheme
- view? int - The ID of the view screen
- edit? int - The ID of the edit screen
- create? int - The ID of the create screen
jira: ScreenWithTab
Closed record
A screen with tab details
Fields
- tab? ScreenableTab - The tab for the screen
- scope? Scope - The scope of the screen
- name? string - The name of the screen
- description? string - The description of the screen
- id? int - The ID of the screen
jira: SearchAndReconcileRequestBean
Closed record
Fields
- expand? string - Use expand to include additional information about issues in the response. Note that, unlike the majority of instances where
expandis specified,expandis defined as a comma-delimited string of values. The expand options are:renderedFieldsReturns field values rendered in HTML format.namesReturns the display name of each field.schemaReturns the schema describing a field type.transitionsReturns all possible transitions for the issue.operationsReturns all possible operations for the issue.editmetaReturns information about how each field can be edited.changelogReturns a list of recent updates to an issue, sorted by date, starting from the most recent.versionedRepresentationsInstead offields, returnsversionedRepresentationsa JSON array containing each version of a field's value, with the highest numbered item representing the most recent version.
"names,changelog"Returns the display name of each field as well as a list of recent updates to an issue
- jql? string - A JQL expression. For performance reasons, this parameter requires a bounded query. A bounded query is a query with a search restriction.
- Example of an unbounded query:
order by key desc. - Example of a bounded query:
assignee = currentUser() order by key.
orderByclause can contain a maximum of 7 fields - Example of an unbounded query:
- maxResults Signed32(default 50) - The maximum number of items to return per page. To manage page size, API 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
idorkeyonly. It returns max 5000 issues
- nextPageToken? string - The token for a page to fetch that is not the first page. The first page has a
nextPageTokenofnull. Use thenextPageTokento fetch the next page of issues
- fieldsByKeys? boolean - Reference fields by their key (rather than ID). The default is
false
- 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:
*allReturns all fields.*navigableReturns navigable fields.idReturns only issue IDs.- Any issue field, prefixed with a dash to exclude.
id. Examples:summary,commentReturns the summary and comments fields only.*all,-commentReturns all fields except comments.
fieldsparameters can be included in a request. Note: By default, this resource returns IDs only. This differs from GET issue where the default is all fields
- reconcileIssues? int[] - Strong consistency issue ids to be reconciled with search results. Accepts max 50 ids
- properties? string[] - A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list
jira: SearchAndReconcileResults
Closed record
The result of a JQL search with issues reconsilation
Fields
- schema? record { JsonTypeBean... } - The schema describing the field types in the search results
- names? record { string... } - The ID and name of each field in the search results
- isLast? boolean - Indicates whether this is the last page of the paginated response
- nextPageToken? string - Continuation token to fetch the next page. If this result represents the last or the only page this token will be null. This token will expire in 7 days
- issues? IssueBean[] - The list of issues found by the search or reconsiliation
jira: SearchAndReconsileIssuesUsingJqlQueries
Represents the Queries record for the operation: searchAndReconsileIssuesUsingJql
Fields
- expand? string - Use expand to include additional information about issues in the response. Note that, unlike the majority of instances where
expandis specified,expandis defined as a comma-delimited string of values. The expand options are:renderedFieldsReturns field values rendered in HTML format.namesReturns the display name of each field.schemaReturns the schema describing a field type.transitionsReturns all possible transitions for the issue.operationsReturns all possible operations for the issue.editmetaReturns information about how each field can be edited.changelogReturns a list of recent updates to an issue, sorted by date, starting from the most recent.versionedRepresentationsInstead offields, returnsversionedRepresentationsa JSON array containing each version of a field's value, with the highest numbered item representing the most recent version.
"names,changelog"Returns the display name of each field as well as a list of recent updates to an issue
- jql? string - A JQL expression. For performance reasons, this parameter requires a bounded query. A bounded query is a query with a search restriction.
- Example of an unbounded query:
order by key desc. - Example of a bounded query:
assignee = currentUser() order by key.
orderByclause can contain a maximum of 7 fields - Example of an unbounded query:
- nextPageToken? string - The token for a page to fetch that is not the first page. The first page has a
nextPageTokenofnull. Use thenextPageTokento fetch the next page of issues. Note: ThenextPageTokenfield is not included in the response for the last page, indicating there is no next page
- maxResults Signed32(default 50) - The maximum number of items to return per page. To manage page size, API may return fewer items per page where a large number of fields or properties are requested. The greatest number of items returned per page is achieved when requesting
idorkeyonly. It returns max 5000 issues
- fieldsByKeys boolean(default false) - Reference fields by their key (rather than ID). The default is
false
- 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:
*allReturns all fields.*navigableReturns navigable fields.idReturns only issue IDs.- Any issue field, prefixed with a minus to exclude.
id. Examples:summary,commentReturns only the summary and comments fields only.-descriptionReturns all navigable (default) fields except description.*all,-commentReturns all fields except comments.
fieldsparameters can be included in a request. Note: By default, this resource returns IDs only. This differs from GET issue where the default is all fields
- reconcileIssues? int[] - Strong consistency issue ids to be reconciled with search results. Accepts max 50 ids
- properties? string[] - A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list
- failFast boolean(default false) - Fail this request early if we can't retrieve all field data
jira: SearchAutoCompleteFilter
Closed record
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(default false) - Include collapsed fields for fields that have non-unique names
jira: SearchForIssuesUsingJqlQueries
Represents the Queries record for the operation: searchForIssuesUsingJql
Fields
- expand? string - Use expand to include additional information about issues in the response. This parameter accepts a comma-separated list. Expand options include:
renderedFieldsReturns field values rendered in HTML format.namesReturns the display name of each field.schemaReturns the schema describing a field type.transitionsReturns all possible transitions for the issue.operationsReturns all possible operations for the issue.editmetaReturns information about how each field can be edited.changelogReturns a list of recent updates to an issue, sorted by date, starting from the most recent.versionedRepresentationsInstead offields, returnsversionedRepresentationsa JSON array containing each version of a field's value, with the highest numbered item representing the most recent version
- jql? string - The JQL that defines the search. Note:
- If no JQL expression is provided, all issues are returned.
usernameanduserkeycannot be used as search terms due to privacy reasons. UseaccountIdinstead.- 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
- maxResults Signed32(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 or properties are requested. The greatest number of items returned per page is achieved when requesting
idorkeyonly
- validateQuery "strict"|"warn"|"none"|"true"|"false" (default "strict") - Determines how to validate the JQL query and treat the validation results. Supported values are:
strictReturns a 400 response code if any errors are found, along with a list of all errors (and warnings).warnReturns all errors as warnings.noneNo validation is performed.trueDeprecated A legacy synonym forstrict.falseDeprecated A legacy synonym forwarn.
validateQueryvalue
- fieldsByKeys boolean(default false) - Reference fields by their key (rather than ID)
- 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:
*allReturns all fields.*navigableReturns navigable fields.- Any issue field, prefixed with a minus to exclude.
summary,commentReturns only the summary and comments fields.-descriptionReturns all navigable (default) fields except description.*all,-commentReturns all fields except comments.
fields=field1,field2&fields=field3. Note: All navigable fields are returned by default. This differs from GET issue where the default is all fields
- startAt Signed32(default 0) - The index of the first item to return in a page of results (page offset)
- properties? string[] - 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
- failFast boolean(default false) - Whether to fail the request quickly in case of an error while loading fields for an issue. For
failFast=true, if one field fails, the entire operation fails. ForfailFast=false, the operation will continue even if a field fails. It will return a valid response, but without values for the failed field(s)
jira: SearchPrioritiesQueries
Represents the Queries record for the operation: searchPriorities
Fields
- priorityName string(default "") - The name of priority to search for
- expand string(default "") - Use
schemesto return the associated priority schemes for each priority. Limited to returning first 15 priority schemes per priority
- onlyDefault boolean(default false) - Whether only the default priority is returned
- maxResults string(default "50") - The maximum number of items to return per page
- id? string[] - The list of priority IDs. To include multiple IDs, provide an ampersand-separated list. For example,
id=2&id=3
- projectId? string[] - The list of projects IDs. To include multiple IDs, provide an ampersand-separated list. For example,
projectId=10010&projectId=10111
- startAt string(default "0") - The index of the first item to return in a page of results (page offset)
jira: SearchProjectsQueries
Represents the Queries record for the operation: searchProjects
Fields
- typeKey? string - Orders results by the project type. This parameter accepts a comma-separated list. Valid values are
business,service_desk, andsoftware
- keys? string[] - The project keys to filter the results by. To include multiple keys, provide an ampersand-separated list. For example,
keys=PA&keys=PB. Up to 50 project keys can be provided
- query? string - Filter the results using a literal string. Projects with a matching
keyornameare returned (case insensitive)
- orderBy "category"|"-category"|"+category"|"key"|"-key"|"+key"|"name"|"-name"|"+name"|"owner"|"-owner"|"+owner"|"issueCount"|"-issueCount"|"+issueCount"|"lastIssueUpdatedDate"|"-lastIssueUpdatedDate"|"+lastIssueUpdatedDate"|"archivedDate"|"+archivedDate"|"-archivedDate"|"deletedDate"|"+deletedDate"|"-deletedDate" (default "key") - Order the results by a field.
categorySorts by project category. A complete list of category IDs is found using Get all project categories.issueCountSorts by the total number of issues in each project.keySorts by project key.lastIssueUpdatedTimeSorts by the last issue update time.nameSorts by project name.ownerSorts by project lead.archivedDateEXPERIMENTAL. Sorts by project archived date.deletedDateEXPERIMENTAL. Sorts by project deleted date
- propertyQuery? string - 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
nestedfrom{"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. Note thatthepropertykeyis only returned when included inproperties
- expand? string - Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expanded options include:
descriptionReturns the project description.projectKeysReturns all project keys associated with a project.leadReturns information about the project lead.issueTypesReturns all issue types associated with the project.urlReturns the URL associated with the project.insightEXPERIMENTAL. Returns the insight details of total issue count and last issue update time for the project
- maxResults Signed32(default 50) - The maximum number of items to return per page. Must be less than or equal to 100. If a value greater than 100 is provided, the
maxResultsparameter will default to 100
- action "view"|"browse"|"edit"|"create" (default "view") - Filter results by projects for which the user can:
-
viewthe 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.
-
browsethe project, meaning that they have the Browse projects project permission for the project. -
editthe project, meaning that they have one of the following permissions: - Administer projects project permission for the project.
- Administer Jira global permission.
-
createthe project, meaning that they have the Create issues project permission for the project in which the issue is created
-
- id? int[] - 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
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
- categoryId? int - The ID of the project's category. A complete list of category IDs is found using the Get all project categories operation
- properties? StringList[] - EXPERIMENTAL. A list of project properties to return for the project. This parameter accepts a comma-separated list
- status? ("live"|"archived"|"deleted")[] - EXPERIMENTAL. Filter results by project status:
liveSearch live projects.archivedSearch archived projects.deletedSearch deleted projects, those in the recycle bin
jira: SearchProjectsUsingSecuritySchemesQueries
Represents the Queries record for the operation: searchProjectsUsingSecuritySchemes
Fields
- issueSecuritySchemeId? string[] - The list of security scheme IDs to be filtered out
- maxResults string(default "50") - The maximum number of items to return per page
- projectId? string[] - The list of project IDs to be filtered out
- startAt string(default "0") - The index of the first item to return in a page of results (page offset)
jira: SearchQueries
Represents the Queries record for the operation: search
Fields
- expand? string - Deprecated. See the deprecation notice for details.
Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:
usagesReturns the project and issue types that use the status in their workflow.workflowUsagesReturns the workflows that use the status
- searchString? string - Term to match status names against or null to search for all statuses in the search scope
- maxResults Signed32(default 200) - The maximum number of items to return per page
- statusCategory? string - Category of the status to filter by. The supported values are:
TODO,IN_PROGRESS, andDONE
- projectId? string - The project the status is part of or null for global statuses
- startAt int(default 0) - The index of the first item to return in a page of results (page offset)
jira: SearchRequestBean
Closed record
Fields
- expand? string[] - Use expand to include additional information about issues in the response. Note that, unlike the majority of instances where
expandis specified,expandis defined as a list of values. The expand options are:renderedFieldsReturns field values rendered in HTML format.namesReturns the display name of each field.schemaReturns the schema describing a field type.transitionsReturns all possible transitions for the issue.operationsReturns all possible operations for the issue.editmetaReturns information about how each field can be edited.changelogReturns a list of recent updates to an issue, sorted by date, starting from the most recent.versionedRepresentationsInstead offields, returnsversionedRepresentationsa JSON array containing each version of a field's value, with the highest numbered item representing the most recent version
- maxResults Signed32(default 50) - The maximum number of items to return per page
- validateQuery? "strict"|"warn"|"none"|"true"|"false" - Determines how to validate the JQL query and treat the validation results. Supported values:
strictReturns a 400 response code if any errors are found, along with a list of all errors (and warnings).warnReturns all errors as warnings.noneNo validation is performed.trueDeprecated A legacy synonym forstrict.falseDeprecated A legacy synonym forwarn.
strict. Note: If the JQL is not correctly formed a 400 response code is returned, regardless of thevalidateQueryvalue
- fieldsByKeys? boolean - Reference fields by their key (rather than ID). The default is
false
- 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:
*allReturns all fields.*navigableReturns navigable fields.- Any issue field, prefixed with a minus to exclude.
*navigable. Examples:summary,commentReturns the summary and comments fields only.-descriptionReturns all navigable (default) fields except description.*all,-commentReturns all fields except comments.
fieldsparameters 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
- properties? string[] - A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list
- startAt? Signed32 - The index of the first item to return in the page of results (page offset). The base index is
0
jira: SearchResolutionsQueries
Represents the Queries record for the operation: searchResolutions
Fields
- onlyDefault boolean(default false) - When set to true, return default only, when IDs provided, if none of them is default, return empty page. Default value is false
- maxResults string(default "50") - The maximum number of items to return per page
- id? string[] - The list of resolutions IDs to be filtered out
- startAt string(default "0") - The index of the first item to return in a page of results (page offset)
jira: SearchResults
Closed record
The result of a JQL search
Fields
- schema? record { JsonTypeBean... } - The schema describing the field types in the search results
- warningMessages? string[] - Any warnings related to the JQL query
- expand? string - Expand options that include additional search result details in the response
- total? Signed32 - The number of results on the page
- names? record { string... } - The ID and name of each field in the search results
- maxResults? Signed32 - The maximum number of results that could be on the page
- issues? IssueBean[] - The list of issues found by the search
- startAt? Signed32 - The index of the first item returned on the page
jira: SearchSecuritySchemesQueries
Represents the Queries record for the operation: searchSecuritySchemes
Fields
- maxResults string(default "50") - The maximum number of items to return per page
- id? string[] - The list of issue security scheme IDs. To include multiple issue security scheme IDs, separate IDs with an ampersand:
id=10000&id=10001
- projectId? string[] - The list of project IDs. To include multiple project IDs, separate IDs with an ampersand:
projectId=10000&projectId=10001
- startAt string(default "0") - The index of the first item to return in a page of results (page offset)
jira: SearchWorkflowsQueries
Represents the Queries record for the operation: searchWorkflows
Fields
- maxResults? Signed32 - The maximum number of items to return per page
- scope? string - The scope of the workflow. Global for company-managed projects and Project for team-managed projects
- queryString? string - String used to perform a case-insensitive partial match with workflow name
- isActive? boolean - Filters active and inactive workflows
- startAt? int - The index of the first item to return in a page of results (page offset)
jira: SecurityLevel
Closed record
Details of an issue level security item
Fields
- isDefault? boolean - Whether the issue level security item is the default
- issueSecuritySchemeId? string - The ID of the issue level security scheme
- name? string - The name of the issue level security item
- description? string - The description of the issue level security item
- self? string - The URL of the issue level security item
- id? string - The ID of the issue level security item
jira: SecurityLevelMember
Issue security level member
Fields
- holder PermissionHolder - The user or group being granted the permission. It consists of a
typeand a type-dependentparameter. See Holder object in Get all permission schemes for more information.
- id string - The ID of the issue security level member.
- issueSecurityLevelId string - The ID of the issue security level.
- issueSecuritySchemeId string - The ID of the issue security scheme.
- managed? boolean -
jira: SecurityLevelMemberPayload
Closed record
The payload for creating a security level member. See https://support.atlassian.com/jira-cloud-administration/docs/configure-issue-security-schemes/
Fields
- 'parameter? string - Defines the value associated with the type. For reporter this would be {"null"}; for users this would be the names of specific users); for group this would be group names like {"administrators", "jira-administrators", "jira-users"}
- 'type? "group"|"reporter"|"users" - The type of the security level member
jira: SecurityLevelPayload
Closed record
The payload for creating a security level. See https://support.atlassian.com/jira-cloud-administration/docs/configure-issue-security-schemes/
Fields
- isDefault? true|false - Whether the security level is default for the security scheme
- securityLevelMembers? SecurityLevelMemberPayload[] - The members of the security level
- name? string - The name of the security level
- description? string - The description of the security level
jira: SecurityScheme
Closed record
Details about a security scheme
Fields
- name? string - The name of the issue security scheme
- defaultSecurityLevelId? int - The ID of the default security level
- description? string - The description of the issue security scheme
- self? string - The URL of the issue security scheme
- id? int - The ID of the issue security scheme
- levels? SecurityLevel[] -
jira: SecuritySchemeId
The ID of the issue security scheme
Fields
- id string - The ID of the issue security scheme.
jira: SecuritySchemeLevelBean
Closed record
Fields
- isDefault? boolean - Specifies whether the level is the default level. False by default
- members? SecuritySchemeLevelMemberBean[] - The list of level members which should be added to the issue security scheme level
- name string - The name of the issue security scheme level. Must be unique
- description? string - The description of the issue security scheme level
jira: SecuritySchemeLevelMemberBean
Closed record
Fields
- 'parameter? string - The value corresponding to the specified member type
- 'type string - The issue security level member type, e.g
reporter,group,user,projectrole,applicationRole
jira: SecuritySchemeMembersRequest
Closed record
Details of issue security scheme level new members
Fields
- members? SecuritySchemeLevelMemberBean[] - The list of level members which should be added to the issue security scheme level
jira: SecuritySchemePayload
Closed record
The payload for creating a security scheme. See https://support.atlassian.com/jira-cloud-administration/docs/configure-issue-security-schemes/
Fields
- name? string - The name of the security scheme
- description? string - The description of the security scheme
- securityLevels? SecurityLevelPayload[] - The security levels for the security scheme
- pcri? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
jira: SecuritySchemes
Closed record
List of security schemes
Fields
- issueSecuritySchemes? SecurityScheme[] - List of security schemes
jira: SecuritySchemeWithProjects
Details about an issue security scheme
Fields
- defaultLevel? int - The default level ID of the issue security scheme.
- description? string - The description of the issue security scheme.
- id int - The ID of the issue security scheme.
- name string - The name of the issue security scheme.
- projectIds? int[] - The list of project IDs associated with the issue security scheme.
- self string - The URL of the issue security scheme.
jira: ServerInformation
Closed record
Details about the Jira instance
Fields
- healthChecks? HealthCheckResult[] - Jira instance health check results. Deprecated and no longer returned
- buildDate? string - The timestamp when the Jira version was built
- serverTimeZone? string - The default timezone of the Jira server. In a format known as Olson Time Zones, IANA Time Zones or TZ Database Time Zones
- buildNumber? Signed32 - The build number of the Jira version
- version? string - The version of Jira
- displayUrl? string - The display URL of the Jira instance
- baseUrl? string - The base URL of the Jira instance
- deploymentType? string - The type of server deployment. This is always returned as Cloud
- scmInfo? string - The unique identifier of the Jira version
- displayUrlServicedeskHelpCenter? string - The display URL of the Servicedesk Help Center
- serverTime? string - The time in Jira when this request was responded to
- serverTitle? string - The name of the Jira instance
- versionNumbers? Signed32[] - The major, minor, and revision version numbers of the Jira version
- displayUrlConfluence? string - The display URL of Confluence
jira: ServiceRegistry
Fields
- organizationId? string - organization ID
- name? string - service name
- serviceTier? ServiceRegistryTier -
- description? string? - service description
- id? string - service ID
- revision? string - service revision
jira: ServiceRegistryResourceServicesGetQueries
Represents the Queries record for the operation: ServiceRegistryResource.services_get
Fields
- serviceIds string[] - The ID of the services (the strings starting with "b:" need to be decoded in Base64)
jira: ServiceRegistryTier
Fields
- level? int - tier level
- nameKey? string - name key of the tier
- name? string? - tier name
- description? string? - tier description
- id? string - tier ID
jira: SetDefaultLevelsRequest
Details of new default levels
Fields
- defaultValues DefaultLevelValue[] - List of objects with issue security scheme ID and new default level ID.
jira: SetDefaultPriorityRequest
Closed record
The new default issue priority
Fields
- id string - The ID of the new default issue priority. Must be an existing ID or null. Setting this to null erases the default priority setting
jira: SetDefaultResolutionRequest
Closed record
The new default issue resolution
Fields
- id string - The ID of the new default issue resolution. Must be an existing ID or null. Setting this to null erases the default resolution setting
jira: SetFavouriteForFilterQueries
Represents the Queries record for the operation: setFavouriteForFilter
Fields
- expand? string - Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:
sharedUsersReturns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specifysharedUsers, then thesharedUsersobject is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append[start-index:end-index]to the expand request. For example, to access the next 1000 users, use?expand=sharedUsers[1001:2000].subscriptionsReturns the users that are subscribed to the filter. If you don't specifysubscriptions, thesubscriptionsobject is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append[start-index:end-index]to the expand request. For example, to access the next 1000 subscriptions, use?expand=subscriptions[1001:2000]
jira: SetPreferenceQueries
Represents the Queries record for the operation: setPreference
Fields
- 'key string - The key of the preference. The maximum length is 255 characters
jira: SetUserColumnsQueries
Represents the Queries record for the operation: setUserColumns
Fields
- accountId? string - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5
jira: SetUserNavPropertyQueries
Represents the Queries record for the operation: setUserNavProperty
Fields
- accountId? string - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5
jira: SetUserPropertyQueries
Represents the Queries record for the operation: setUserProperty
Fields
- accountId? string - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5
- userKey? string - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details
- username? string - This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details
jira: SharePermission
Closed record
Details of a share permission for the filter
Fields
- role? ProjectRole - The project role that the filter is shared with.
For a request, specify theidfor the role. You must also specify theprojectobject andidfor the project that the role is in
- 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 theidfor the project
- id? int - The unique identifier of the share permission
- 'type "user"|"group"|"project"|"projectRole"|"global"|"loggedin"|"authenticated"|"project-unknown" - The type of share permission:
userShared with a user.groupShared with a group. If set in a request, then specifysharePermission.groupas well.projectShared with a project. If set in a request, then specifysharePermission.projectas well.projectRoleShare 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 withprojectIdandprojectRoleId.globalShared globally. If set in a request, no othersharePermissionproperties need to be specified.loggedinShared with all logged-in users. Note: This value is set in a request by specifyingauthenticatedas thetype.project-unknownShared with a project that the user does not have access to. Cannot be set in a request
- user? UserBean - The user account ID that the filter is shared with. For a request, specify the
accountIdproperty for the user
- group? GroupName - The group that the filter is shared with. For a request, specify the
groupIdornameproperty for the group. As a group's name can change, use ofgroupIdis recommended
jira: SharePermissionInputBean
Closed record
Fields
- accountId? string - The user account ID that the filter is shared with. For a request, specify the
accountIdproperty for the user
- groupId? string - The ID of the group, which uniquely identifies the group across all Atlassian products.For example, 952d12c3-5b5b-4d04-bb32-44d383afc4b2. Cannot be provided with
groupname
- rights? Signed32 - The rights for the share permission
- 'type "user"|"project"|"group"|"projectRole"|"global"|"authenticated" - The type of the share permission.Specify the type as follows:
userShare with a user.groupShare with a group. Specifygroupnameas well.projectShare with a project. SpecifyprojectIdas well.projectRoleShare with a project role in a project. SpecifyprojectIdandprojectRoleIdas well.globalShare 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.authenticatedShare with all logged-in users. This shows asloggedinin the response. If set, this type overrides all existing share permissions and must be deleted before any non-global share permissions is set
- groupname? string - The name of the group to share the filter with. Set
typetogroup. Please note that the name of a group is mutable, to reliably identify a group usegroupId
- projectId? string - The ID of the project to share the filter with. Set
typetoproject
- projectRoleId? string - The ID of the project role to share the filter with. Set
typetoprojectRoleand theprojectIdfor the project that the role is in
jira: SimpleApplicationPropertyBean
Closed record
Fields
- id? string - The ID of the application property
- value? string - The new value
jira: SimpleLink
Closed record
Details about the operations available in this version
Fields
- weight? Signed32 -
- href? string -
- id? string -
- label? string -
- styleClass? string -
- title? string -
- iconClass? string -
jira: SimpleListWrapperApplicationRole
Closed record
Fields
- pagingCallback? ListWrapperCallbackApplicationRole -
- size? Signed32 -
- maxResults? Signed32 -
- callback? ListWrapperCallbackApplicationRole -
- items? ApplicationRole[] -
jira: SimpleListWrapperGroupName
Closed record
Fields
- pagingCallback? ListWrapperCallbackGroupName -
- size? Signed32 -
- maxResults? Signed32 -
- callback? ListWrapperCallbackGroupName -
- items? GroupName[] -
jira: SimpleUsage
Closed record
Represents a usage of an entity by a project ID and related issue type IDs
Fields
- issueTypeIds string[] - The issue type IDs for the usage
- projectId string - The project ID for the usage
jira: SimplifiedHierarchyLevel
Closed record
Fields
- externalUuid? string - The external UUID of the hierarchy level. 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
- 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
- level? Signed32 - The level of this item in the hierarchy
- issueTypeIds? int[] - The issue types available in this hierarchy level
- name? string - The name of this hierarchy level
- id? int - The ID of the hierarchy level. This property is deprecated, see Change notice: Removing hierarchy level IDs from next-gen APIs
- hierarchyLevelNumber? Signed32 -
- 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
jira: SimplifiedIssueTransition
Closed record
Fields
- transitionId? Signed32 - The unique ID of the transition
- to? IssueTransitionStatus - The issue status change of the transition
- transitionName? string - The name of the transition
jira: SingleRedactionRequest
Closed record
Fields
- reason string - The reason why the content is being redacted
- redactionPosition RedactionPosition - Represents the position of the redaction
- contentItem ContentItem - Represents the content to redact
- externalId string - Unique id for the redaction request; ID format should be of UUID
jira: SingleRedactionResponse
Closed record
Result for requested redactions
Fields
- externalId string - An unique id for the redaction request
- successful boolean - Indicates if redaction was success/failure
jira: Status
The status of the item
Fields
- icon? Icon - Details of the icon representing the status. If not provided, no status icon displays in Jira.
- 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.
jira: StatusCategory
A status category
Fields
- colorName? string - The name of the color used to represent the status category.
- id? int - The ID of the status category.
- 'key? string - The key of the status category.
- name? string - The name of the status category.
- self? string - The URL of the status category.
jira: StatusCreate
Closed record
Details of the status being created
Fields
- name string - The name of the status
- description? string - The description of the status
- statusCategory "TODO"|"IN_PROGRESS"|"DONE" - The category of the status
jira: StatusCreateRequest
Closed record
Details of the statuses being created and their scope
Fields
- scope StatusScope - The scope of the status
- statuses StatusCreate[] - Details of the statuses being created
jira: StatusDetails
A status
Fields
- description? string - The description of the status.
- iconUrl? string - The URL of the icon used to represent the status.
- id? string - The ID of the status.
- name? string - The name of the status.
- scope? Scope - The scope of the field.
- self? string - The URL of the status.
- statusCategory? StatusCategory - The category assigned to the status.
jira: StatusesPerWorkflow
Closed record
The statuses associated with each workflow
Fields
- statuses? string[] - The status IDs associated with the workflow
- initialStatusId? string - The ID of the initial status for the workflow
- workflowId? string - The ID of the workflow
jira: StatusLayoutUpdate
The statuses associated with this workflow
Fields
- approvalConfiguration? ApprovalConfiguration? - The approval configuration of a status within a workflow. Applies only to Jira Service Management approvals
- layout? WorkflowLayout? - The starting point for the statuses in the workflow
- properties record { string... } - The properties for this status layout.
- statusReference string - A unique ID which the status will use to refer to this layout configuration.
jira: StatusMapping
Closed record
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: StatusMappingDTO
The mapping of old to new status ID for a specific project and issue type
Fields
- issueTypeId string - The issue type for the status mapping.
- projectId string - The project for the status mapping.
- statusMigrations StatusMigration[] - The list of old and new status ID mappings for the specified project and issue type.
jira: StatusMetadata
Closed record
The details of the statuses in the associated workflows
Fields
- name? string - The name of the status
- id? string - The ID of the status
- category? "TODO"|"IN_PROGRESS"|"DONE" - The category of the status
jira: StatusMigration
The mapping of old to new status ID
Fields
- newStatusReference string - The new status ID.
- oldStatusReference string - The old status ID.
jira: StatusPayload
Closed record
The payload for creating a status
Fields
- onConflict? "FAIL"|"USE"|"NEW" - The conflict strategy for the status already exists. FAIL - Fail execution, this always needs to be unique; USE - Use the existing entity and ignore new entity parameters; NEW - Create a new entity
- name? string - The name of the status
- description? string - The description of the status
- statusCategory? "TODO"|"IN_PROGRESS"|"DONE" - The status category of the status. The value is case-sensitive
- pcri? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
jira: StatusProjectIssueTypeUsage
Closed record
The list of issue types
Fields
- id? string - The issue type ID
jira: StatusProjectIssueTypeUsageDTO
Closed record
The issue types using this status in a project
Fields
- statusId? string - The status ID
- projectId? string - The project ID
- issueTypes? StatusProjectIssueTypeUsagePage - A page of issue types
jira: StatusProjectIssueTypeUsagePage
Closed record
A page of issue types
Fields
- nextPageToken? string - Page token for the next page of issue type usages
- values? StatusProjectIssueTypeUsage[] - The list of issue types
jira: StatusProjectUsage
Closed record
The project
Fields
- id? string - The project ID
jira: StatusProjectUsageDTO
Closed record
The projects using this status
Fields
- projects? StatusProjectUsagePage - A page of projects
- statusId? string - The status ID
jira: StatusProjectUsagePage
Closed record
A page of projects
Fields
- nextPageToken? string - Page token for the next page of issue type usages
- values? StatusProjectUsage[] - The list of projects
jira: StatusScope
Closed record
The scope of the status
Fields
- project? ProjectId? - Project ID details
- 'type "PROJECT"|"GLOBAL" - The scope of the status.
GLOBALfor company-managed projects andPROJECTfor team-managed projects
jira: StatusUpdate
Details of the status being updated
Fields
- description? string - The description of the status.
- id string - The ID of the status.
- name string - The name of the status.
- statusCategory "TODO"|"IN_PROGRESS"|"DONE" - The category of the status.
jira: StatusUpdateRequest
Closed record
The list of statuses that will be updated
Fields
- statuses StatusUpdate[] - The list of statuses that will be updated
jira: StatusWorkflowUsageDTO
Closed record
Workflows using the status
Fields
- statusId? string - The status ID
- workflows? StatusWorkflowUsagePage - A page of workflows
jira: StatusWorkflowUsagePage
Closed record
A page of workflows
Fields
- nextPageToken? string - Page token for the next page of issue type usages
- values? StatusWorkflowUsageWorkflow[] - The list of statuses
jira: StatusWorkflowUsageWorkflow
Closed record
The worflow
Fields
- id? string - The workflow ID
jira: StoreAvatarQueries
Represents the Queries record for the operation: storeAvatar
Fields
- size Signed32(default 0) - The length of each side of the crop region
- x Signed32(default 0) - The X coordinate of the top-left corner of the crop region
- y Signed32(default 0) - The Y coordinate of the top-left corner of the crop region
jira: StreamingResponseBody
Closed record
jira: StringList
Closed record
jira: SubmittedBulkOperation
Closed record
Fields
- taskId? string -
jira: SuggestedIssue
Closed record
An issue suggested for use in the issue picker auto-completion
Fields
- summary? string - The phrase containing the query string in HTML format, with the string highlighted with HTML bold tags
- img? string - The URL of the issue type's avatar
- keyHtml? string - The key of the issue in HTML format
- summaryText? string - The phrase containing the query string, as plain text
- id? int - The ID of the issue
- 'key? string - The key of the issue
jira: SuggestedMappingsForPrioritiesRequestBean
Closed record
Details of changes to a priority scheme's priorities that require suggested priority mappings
Fields
- add? int[] - The ids of priorities being removed from the scheme
- remove? int[] - The ids of priorities being removed from the scheme
jira: SuggestedMappingsForProjectsRequestBean
Closed record
Details of changes to a priority scheme's projects that require suggested priority mappings
Fields
- add? int[] - The ids of projects being added to the scheme
jira: SuggestedMappingsRequestBean
Closed record
Details of changes to a priority scheme that require suggested priority mappings
Fields
- priorities? SuggestedMappingsForPrioritiesRequestBean - The priority changes in the scheme
- projects? SuggestedMappingsForProjectsRequestBean - The project changes in the scheme
- maxResults? Signed32 - The maximum number of results that could be on the page
- schemeId? int - The id of the priority scheme
- startAt? int - The index of the first item returned on the page
jira: SwimlanePayload
Closed record
The payload for custom swimlanes
Fields
- jqlQuery? string - The jql query for the quick filter
- name? string - The name of the quick filter
- description? string - The description of the quick filter
jira: SwimlanesPayload
Closed record
The payload for customising a swimlanes on a board
Fields
- defaultCustomSwimlaneName? string - The name of the custom swimlane to use for work items that don't match any other swimlanes
- customSwimlanes? SwimlanePayload[] - The custom swimlane definitions
- swimlaneStrategy? "none"|"custom"|"parentChild"|"assignee"|"assigneeUnassignedFirst"|"epic"|"project"|"issueparent"|"issuechildren"|"request_type" - The swimlane strategy for the board
jira: SystemAvatars
Closed record
List of system avatars
Fields
- system? Avatar[] - A list of avatar details
jira: TabPayload
Closed record
Defines the payload for the tabs of the screen. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-tab-fields/\#api-rest-api-3-screens-screenid-tabs-tabid-fields-post
Fields
- name? string - The name of the tab
- fields? ProjectCreateResourceIdentifier[] - The list of resource identifier of the field associated to the tab. See https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-tab-fields/#api-rest-api-3-screens-screenid-tabs-tabid-fields-post
jira: TargetClassification
Closed record
Classification mapping for classifications in source issues to respective target classification
Fields
- issueType? string - ID of the source issueType to which issues present in
issueIdOrKeysbelongs
- classifications record { string[]... } - An object with the key as the ID of the target classification and value with the list of the IDs of the current source classifications
- projectKeyOrId? string - ID or key of the source project to which issues present in
issueIdOrKeysbelongs
jira: TargetMandatoryFields
Closed record
Field mapping for mandatory fields in target
Fields
- fields record { Fields1... } - Contains the value of mandatory fields
jira: TargetStatus
Closed record
Status mapping for statuses in source workflow to respective target status in target workflow
Fields
- statuses record { string[]... } - An object with the key as the ID of the target status and value with the list of the IDs of the current source statuses
jira: TargetToSourcesMapping
Closed record
An object representing the mapping of issues and data related to destination entities, like fields and statuses, that are required during a bulk move
Fields
- inferSubtaskTypeDefault boolean - When an issue is moved, its subtasks (if there are any) need to be moved with it.
inferSubtaskTypeDefaulthelps with moving the subtasks by picking a random subtask type in the target project. Iftrue, subtasks will automatically move to the same project as their parent. When they move:- Their
issueTypewill be set to the default for subtasks in the target project. - Values for mandatory fields will be retained from the source issues
- Specifying separate mapping for implicit subtasks won’t be allowed.
false, you must manually move the subtasks. They will retain the parent which they had in the current project after being moved - Their
- inferClassificationDefaults boolean - If
true, when issues are moved into this target group, they will adopt the target project's default classification, if they don't have a classification already. If they do have a classification, it will be kept the same even after the move. LeavetargetClassificationempty when using this. Iffalse, you must provide atargetClassificationmapping for each classification associated with the selected issues. Benefit from data classification
- targetMandatoryFields? TargetMandatoryFields[]? - List of objects containing mandatory fields in the target field configuration and new values that need to be set during the bulk move operation.
The new values will only be applied if the field is mandatory in the target project and at least one issue from the source has that field empty, or if the field context is different in the target project (e.g. project-scoped version fields).
You should only define this property when
inferFieldDefaultsisfalse.
- inferFieldDefaults boolean - If
true, values from the source issues will be retained for the mandatory fields in the field configuration of the destination project. ThetargetMandatoryFieldsproperty shouldn't be defined. Iffalse, the user is required to set values for mandatory fields present in the field configuration of the destination project. Provide input by defining thetargetMandatoryFieldsproperty
- issueIdsOrKeys? string[] - List of issue IDs or keys to be moved
- inferStatusDefaults boolean - If
true, the statuses of issues being moved in this target group that are not present in the target workflow will be changed to the default status of the target workflow (see below). LeavetargetStatusempty when using this. Iffalse, you must provide atargetStatusfor each status not present in the target workflow. The default status in a workflow is referred to as the "initial status". Each workflow has its own unique initial status. When an issue is created, it is automatically assigned to this initial status. Read more about configuring initial statuses: Configure the initial status | Atlassian Support.
- targetClassification? TargetClassification[]? - List of the objects containing classifications in the source issues and their new values which need to be set during the bulk move operation.
It is mandatory to provide source classification to target classification mapping when the source classification is invalid for the target project and issue type.
- You should only define this property when
inferClassificationDefaultsisfalse. - In order to provide mapping for issues which don't have a classification, use
"-1".
- You should only define this property when
- targetStatus? TargetStatus[]? - List of the objects containing statuses in the source workflow and their new values which need to be set during the bulk move operation.
The new values will only be applied if the source status is invalid for the target project and issue type.
It is mandatory to provide source status to target status mapping when the source status is invalid for the target project and issue type.
You should only define this property when
inferStatusDefaultsisfalse.
jira: TaskProgressBeanJsonNode
Closed record
Details about a task
Fields
- submittedBy int - The ID of the user who submitted the task
- description? string - The description of the task
- finished? int - A timestamp recording when the task was finished
- started? int - A timestamp recording when the task was started
- message? string - Information about the progress of the task
- result? JsonNode - The result of the task execution
- submitted int - A timestamp recording when the task was submitted
- lastUpdate int - A timestamp recording when the task progress was last updated
- progress int - The progress of the task, as a percentage complete
- self string - The URL of the task
- id string - The ID of the task
- elapsedRuntime int - The execution time of the task, in milliseconds
- status "ENQUEUED"|"RUNNING"|"COMPLETE"|"FAILED"|"CANCEL_REQUESTED"|"CANCELLED"|"DEAD" - The status of the task
jira: TaskProgressBeanObject
Closed record
Details about a task
Fields
- submittedBy int - The ID of the user who submitted the task
- description? string - The description of the task
- finished? int - A timestamp recording when the task was finished
- started? int - A timestamp recording when the task was started
- message? string - Information about the progress of the task
- result? anydata - The result of the task execution
- submitted int - A timestamp recording when the task was submitted
- lastUpdate int - A timestamp recording when the task progress was last updated
- progress int - The progress of the task, as a percentage complete
- self string - The URL of the task
- id string - The ID of the task
- elapsedRuntime int - The execution time of the task, in milliseconds
- status "ENQUEUED"|"RUNNING"|"COMPLETE"|"FAILED"|"CANCEL_REQUESTED"|"CANCELLED"|"DEAD" - The status of the task
jira: TimeTrackingConfiguration
Closed record
Details of the time tracking configuration
Fields
- defaultUnit "minute"|"hour"|"day"|"week" - The default unit of time applied to logged time
- workingHoursPerDay decimal - The number of hours in a working day
- timeFormat "pretty"|"days"|"hours" - The format that will appear on an issue's Time Spent field
- workingDaysPerWeek decimal - The number of days in a working week
jira: TimeTrackingDetails
Closed record
Time tracking details
Fields
- originalEstimateSeconds? int - The original estimate of time needed for this issue in seconds
- timeSpentSeconds? int - Time worked on this issue in seconds
- timeSpent? string - Time worked on this issue in readable format
- remainingEstimate? string - The remaining estimate of time needed for this issue in readable format
- remainingEstimateSeconds? int - The remaining estimate of time needed for this issue in seconds
- originalEstimate? string - The original estimate of time needed for this issue in readable format
jira: TimeTrackingProvider
Closed record
Details about the time tracking provider
Fields
- name? string - The name of the time tracking provider. For example, JIRA provided time tracking
- 'key string - The key for the time tracking provider. For example, JIRA
- 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
adminPageKeyproperty is set in the module descriptor of the time tracking provider app
jira: ToLayoutPayload
Closed record
The payload for the layout details for the destination end of a transition
Fields
- port? Signed32 - Defines where the transition line will be connected to a status. Port 0 to 7 are acceptable values
- status? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
jira: Transition
Closed record
Details of a workflow transition
Fields
- name string - The name of the transition
- description string - The description of the transition
- screen? TransitionScreenDetails - The details of a transition screen
- 'from string[] - The statuses the transition can start from
- rules? WorkflowRules - A collection of transition rules
- id string - The ID of the transition
- to string - The status the transition goes to
- 'type "global"|"initial"|"directed" - The type of the transition
- properties? record {} - The properties of the transition
jira: TransitionPayload
Closed record
The payload for creating a transition in a workflow. Can be DIRECTED, GLOBAL, SELF-LOOPED, GLOBAL LOOPED
Fields
- validators? RulePayload[] - The validators that are performed when the transition is made
- description? string - The description of the transition
- triggers? RulePayload[] - The triggers that are performed when the transition is made
- 'type? "global"|"initial"|"directed" - The type of the transition
- customIssueEventId? string - Mechanism in Jira for triggering certain actions, like notifications, automations, etc. Unless a custom notification scheme is configure, it's better not to provide any value here
- transitionScreen? RulePayload - The payload for creating rules in a workflow
- name? string - The name of the transition
- 'from? FromLayoutPayload[] - The statuses that the transition can be made from
- id? Signed32 - The id of the transition
- to? ToLayoutPayload - The payload for the layout details for the destination end of a transition
- conditions? ConditionGroupPayload - The payload for creating a condition group in a workflow
- actions? RulePayload[] - The actions that are performed when the transition is made
- properties? record { string... } - The properties of the transition
jira: Transitions
Closed record
List of issue transitions
Fields
- expand? string - Expand options that include additional transitions details in the response
- transitions? IssueTransition[] - List of issue transitions
jira: TransitionScreenDetails
Closed record
The details of a transition screen
Fields
- name? string - The name of the screen
- id string - The ID of the screen
jira: TransitionUpdateDTO
The transition update data
Fields
- actions? WorkflowRuleConfiguration[] - The post-functions of the transition.
- conditions? ConditionGroupUpdate? - The conditions group associated with the transition
- customIssueEventId? string - The custom event ID of the transition.
- description? string - The description of the transition.
- id? string - The ID of the transition.
- links? WorkflowTransitionLinks[] - The statuses the transition can start from, and the mapping of ports between the statuses.
- name? string - The name of the transition.
- properties? record { string... } - The properties of the transition.
- toStatusReference? string - The status the transition goes to.
- transitionScreen? WorkflowRuleConfiguration? - The configuration of the rule
- triggers? WorkflowTrigger[] - The triggers of the transition.
- 'type? "INITIAL"|"GLOBAL"|"DIRECTED" - The transition type.
- validators? WorkflowRuleConfiguration[] - The validators of the transition.
jira: UiModificationContextDetails
Closed record
The details of a UI modification's context, which define where to activate the UI modification
Fields
- isAvailable? boolean - Whether a context is available. For example, when a project is deleted the context becomes unavailable
- issueTypeId? string - The issue type ID of the context. Null is treated as a wildcard, meaning the UI modification will be applied to all issue types. Each UI modification context can have a maximum of one wildcard
- viewType? "GIC"|"IssueView"|"IssueTransition" - The view type of the context. Only
GIC(Global Issue Create),IssueViewandIssueTransitionare supported. Null is treated as a wildcard, meaning the UI modification will be applied to all view types. Each UI modification context can have a maximum of one wildcard
- id? string - The ID of the UI modification context
- projectId? string - The project ID of the context. Null is treated as a wildcard, meaning the UI modification will be applied to all projects. Each UI modification context can have a maximum of one wildcard
jira: UiModificationDetails
Closed record
The details of a UI modification
Fields
- data? string - The data of the UI modification. The maximum size of the data is 50000 characters
- name string - The name of the UI modification. The maximum length is 255 characters
- description? string - The description of the UI modification. The maximum length is 255 characters
- self string - The URL of the UI modification
- contexts? UiModificationContextDetails[] - List of contexts of the UI modification. The maximum number of contexts is 1000
- id string - The ID of the UI modification
jira: UiModificationIdentifiers
Closed record
Identifiers for a UI modification
Fields
- self string - The URL of the UI modification
- id string - The ID of the UI modification
jira: UnrestrictedUserEmail
Fields
- accountId? string - The accountId of the user
- email? string - The email of the user
jira: UpdateCommentQueries
Represents the Queries record for the operation: updateComment
Fields
- overrideEditableFlag boolean(default false) - Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect app users with the Administer Jira global permission and Forge apps acting on behalf of users with Administer Jira global permission
- notifyUsers boolean(default true) - Whether users are notified when a comment is updated
jira: UpdateCustomFieldDetails
Closed record
Details of a custom field
Fields
- searcherKey? "com.atlassian.jira.plugin.system.customfieldtypes:cascadingselectsearcher"|"com.atlassian.jira.plugin.system.customfieldtypes:daterange"|"com.atlassian.jira.plugin.system.customfieldtypes:datetimerange"|"com.atlassian.jira.plugin.system.customfieldtypes:exactnumber"|"com.atlassian.jira.plugin.system.customfieldtypes:exacttextsearcher"|"com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher"|"com.atlassian.jira.plugin.system.customfieldtypes:labelsearcher"|"com.atlassian.jira.plugin.system.customfieldtypes:multiselectsearcher"|"com.atlassian.jira.plugin.system.customfieldtypes:numberrange"|"com.atlassian.jira.plugin.system.customfieldtypes:projectsearcher"|"com.atlassian.jira.plugin.system.customfieldtypes:textsearcher"|"com.atlassian.jira.plugin.system.customfieldtypes:userpickergroupsearcher"|"com.atlassian.jira.plugin.system.customfieldtypes:versionsearcher" - 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:cascadingselectsearcherdatepicker:daterangedatetime:datetimerangefloat:exactnumberornumberrangegrouppicker:grouppickersearcherimportid:exactnumberornumberrangelabels:labelsearchermulticheckboxes:multiselectsearchermultigrouppicker:multiselectsearchermultiselect:multiselectsearchermultiuserpicker:userpickergroupsearchermultiversion:versionsearcherproject:projectsearcherradiobuttons:multiselectsearcherreadonlyfield:textsearcherselect:multiselectsearchertextarea:textsearchertextfield:textsearcherurl:exacttextsearcheruserpicker:userpickergroupsearcherversion:versionsearcher
- 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
jira: UpdateCustomFieldValueQueries
Represents the Queries record for the operation: updateCustomFieldValue
Fields
- generateChangelog boolean(default true) - Whether to generate a changelog for this update
jira: UpdateDashboardQueries
Represents the Queries record for the operation: updateDashboard
Fields
- extendAdminPermissions boolean(default false) - Whether admin level permissions are used. It should only be true if the user has Administer Jira global permission
jira: UpdateDefaultProjectClassificationBean
Closed record
The request for updating the default project classification level
Fields
- id string - The ID of the project classification
jira: UpdateDefaultScreenScheme
Closed record
The ID of a screen scheme
Fields
- screenSchemeId string - The ID of the screen scheme
jira: UpdatedProjectCategory
Closed record
A project category
Fields
- name? string - The description of the project category
- description? string - The name of the project category
- self? string - The URL of the project category
- id? string - The ID of the project category
jira: UpdateDraftWorkflowMappingQueries
Represents the Queries record for the operation: updateDraftWorkflowMapping
Fields
- workflowName string - The name of the workflow
jira: UpdateFieldConfigurationSchemeDetails
Closed record
The details of the field configuration scheme
Fields
- name string - The name of the field configuration scheme. The name must be unique
- description? string - The description of the field configuration scheme
jira: UpdateFilterQueries
Represents the Queries record for the operation: updateFilter
Fields
- expand? string - Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:
sharedUsersReturns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specifysharedUsers, then thesharedUsersobject is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append[start-index:end-index]to the expand request. For example, to access the next 1000 users, use?expand=sharedUsers[1001:2000].subscriptionsReturns the users that are subscribed to the filter. If you don't specifysubscriptions, thesubscriptionsobject is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append[start-index:end-index]to the expand request. For example, to access the next 1000 subscriptions, use?expand=subscriptions[1001:2000]
jira: UpdateIssueSecurityLevelDetails
Details of issue security scheme level
Fields
- description? string - The description of the issue security scheme level.
- name? string - The name of the issue security scheme level. Must be unique.
jira: UpdateIssueSecuritySchemeRequestBean
Closed record
Fields
- name? string - The name of the security scheme scheme. Must be unique
- description? string - The description of the security scheme scheme
jira: UpdateMultipleCustomFieldValuesQueries
Represents the Queries record for the operation: updateMultipleCustomFieldValues
Fields
- generateChangelog boolean(default true) - Whether to generate a changelog for this update
jira: UpdateNotificationSchemeDetails
Details of a notification scheme
Fields
- description? string - The description of the notification scheme.
- name? string - The name of the notification scheme. Must be unique.
jira: UpdatePermissionSchemeQueries
Represents the Queries record for the operation: updatePermissionScheme
Fields
- expand? string - 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:
allReturns all expandable information.fieldReturns information about the custom field granted the permission.groupReturns information about the group that is granted the permission.permissionsReturns all permission grants for each permission scheme.projectRoleReturns information about the project role granted the permission.userReturns information about the user who is granted the permission
jira: UpdatePlanQueries
Represents the Queries record for the operation: updatePlan
Fields
- useGroupId boolean(default false) - Whether to accept group IDs instead of group names. Group names are deprecated
jira: UpdatePrecomputationsQueries
Represents the Queries record for the operation: updatePrecomputations
Fields
- skipNotFoundPrecomputations boolean(default false) -
jira: UpdatePrioritiesInSchemeRequestBean
Update priorities in a scheme
Fields
- add? PrioritySchemeChangesWithoutMappings - Priorities to add to a scheme
- remove? PrioritySchemeChangesWithoutMappings - Priorities to remove from a scheme
jira: UpdatePriorityDetails
Details of an issue priority
Fields
- avatarId? int - The ID for the avatar for the priority. This parameter is nullable and both iconUrl and avatarId cannot be defined.
- description? string? - The description of the priority.
- iconUrl? "/images/icons/priorities/blocker.png"|"/images/icons/priorities/critical.png"|"/images/icons/priorities/high.png"|"/images/icons/priorities/highest.png"|"/images/icons/priorities/low.png"|"/images/icons/priorities/lowest.png"|"/images/icons/priorities/major.png"|"/images/icons/priorities/medium.png"|"/images/icons/priorities/minor.png"|"/images/icons/priorities/trivial.png"|"/images/icons/priorities/blocker_new.png"|"/images/icons/priorities/critical_new.png"|"/images/icons/priorities/high_new.png"|"/images/icons/priorities/highest_new.png"|"/images/icons/priorities/low_new.png"|"/images/icons/priorities/lowest_new.png"|"/images/icons/priorities/major_new.png"|"/images/icons/priorities/medium_new.png"|"/images/icons/priorities/minor_new.png"|"/images/icons/priorities/trivial_new.png"? - The URL of an icon for the priority. Accepted protocols are HTTP and HTTPS. Built in icons can also be used. Both iconUrl and avatarId cannot be defined.
- name? string? - The name of the priority. Must be unique.
- statusColor? string? - The status color of the priority in 3-digit or 6-digit hexadecimal format.
jira: UpdatePrioritySchemeRequestBean
Closed record
Details of a priority scheme
Fields
- mappings? PriorityMapping - Instructions to migrate the priorities of issues.
inmappings are used to migrate the priorities of issues to priorities used within the priority scheme.outmappings are used to migrate the priorities of issues to priorities not used within the priority scheme.- When priorities are added to the priority scheme, no mapping needs to be provided as the new priorities are not used by any issues.
- When priorities are removed from the priority scheme, issues that are using those priorities must be migrated to new priorities used by the priority scheme.
-
An
inmapping must be provided for each of these priorities. - When projects are added to the priority scheme, the priorities of issues in those projects might need to be migrated to new priorities used by the priority scheme. This can occur when the current scheme does not use all the priorities in the project(s)' priority scheme(s).
-
An
inmapping must be provided for each of these priorities. - When projects are removed from the priority scheme, the priorities of issues in those projects might need to be migrated to new priorities within the Default Priority Scheme that are not used by the priority scheme. This can occur when the Default Priority Scheme does not use all the priorities within the current scheme.
-
An
outmapping must be provided for each of these priorities.
inandoutmappings, see the child properties documentation for thePriorityMappingobject below
- priorities? UpdatePrioritiesInSchemeRequestBean - The priorities in the scheme
- projects? UpdateProjectsInSchemeRequestBean - The projects in the scheme
- defaultPriorityId? int - The default priority of the scheme
- name? string - The name of the priority scheme. Must be unique
- description? string - The description of the priority scheme
jira: UpdatePrioritySchemeResponseBean
Details of the updated priority scheme
Fields
- priorityScheme? PrioritySchemeWithPaginatedPrioritiesAndProjects - A priority scheme with paginated priorities and projects
- task? TaskProgressBeanJsonNode - The in-progress issue migration task.
jira: UpdateProjectDetails
Closed record
Details about the project
Fields
- 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
- description? string - A brief description of the project
- leadAccountId? string - The account ID of the project lead. Cannot be provided with
lead
- lead? string - This parameter is deprecated because of privacy changes. Use
leadAccountIdinstead. See the migration guide for details. The user name of the project lead. Cannot be provided withleadAccountId
- url? string - A link to information about this project, such as project documentation
- releasedProjectKeys? string[] - Previous project keys to be released from the current project. Released keys must belong to the current project and not contain the current project key
- 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
- name? string - The name of the project
- 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
- assigneeType? "PROJECT_LEAD"|"UNASSIGNED" - The default assignee when creating issues for this project
- categoryId? int - The ID of the project's category. A complete list of category IDs is found using the Get all project categories operation. To remove the project category from the project, set the value to
-1.
- '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
jira: UpdateProjectQueries
Represents the Queries record for the operation: updateProject
Fields
- expand? string - 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:
descriptionThe project description.issueTypesThe issue types associated with the project.leadThe project lead.projectKeysAll project keys associated with the project
jira: UpdateProjectsInSchemeRequestBean
Update projects in a scheme
Fields
- add? PrioritySchemeChangesWithoutMappings - Projects to add to a scheme
- remove? PrioritySchemeChangesWithoutMappings - Projects to remove from a scheme
jira: UpdateResolutionDetails
Details of an issue resolution
Fields
- description? string - The description of the resolution.
- name string - The name of the resolution. Must be unique.
jira: UpdateScreenDetails
Closed record
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
Closed record
Details of a screen scheme
Fields
- screens? UpdateScreenTypes - The IDs of the screens for the screen types of the screen scheme. Only screens used in classic projects are accepted
- 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
jira: UpdateScreenTypes
Closed record
The IDs of the screens for the screen types of the screen scheme
Fields
- default? string - The ID of the default screen. When specified, must include a screen ID as a default screen is required
- view? string - The ID of the view screen. To remove the screen association, pass a null
- 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
jira: UpdateUiModificationDetails
Closed record
The details of a UI modification
Fields
- data? string - The data of the UI modification. The maximum size of the data is 50000 characters
- name? string - The name of the UI modification. The maximum length is 255 characters
- description? string - The description of the UI modification. The maximum length is 255 characters
- contexts? UiModificationContextDetails[] - List of contexts of the UI modification. The maximum number of contexts is 1000. If provided, replaces all existing contexts
jira: UpdateUserToGroupBean
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. See the deprecation notice for details.
jira: UpdateWorkflowMappingQueries
Represents the Queries record for the operation: updateWorkflowMapping
Fields
- workflowName string - The name of the workflow
jira: UpdateWorkflowsQueries
Represents the Queries record for the operation: updateWorkflows
Fields
- expand? string - Deprecated. See the deprecation notice for details. Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:
workflows.usagesReturns the project and issue types that each workflow is associated with.statuses.usagesReturns the project and issue types that each status is associated with
jira: UpdateWorkflowTransitionPropertyQueries
Represents the Queries record for the operation: updateWorkflowTransitionProperty
Fields
- workflowMode? "live"|"draft" - The workflow status. Set to
livefor inactive workflows ordraftfor draft workflows. Active workflows cannot be edited
- workflowName string - The name of the workflow that the transition belongs to
- '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
keydefined in the request body
jira: UpdateWorklogQueries
Represents the Queries record for the operation: updateWorklog
Fields
- newEstimate? string - 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
adjustEstimateisnew
- adjustEstimate "new"|"leave"|"manual"|"auto" (default "auto") - Defines how to update the issue's time estimate, the options are:
newSets the estimate to a specific value, defined innewEstimate.leaveLeaves the estimate unchanged.autoUpdates the estimate by the difference between the original and updated value oftimeSpentortimeSpentSeconds
- 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. Connect and Forge app users with Administer Jira global permission can use this flag
- notifyUsers boolean(default true) - Whether users watching the issue are notified by email
jira: User
Closed record
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,
displayNameprovides 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,
accountIdreturns 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
- 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
- accountType? "atlassian"|"app"|"customer"|"unknown" - The user account type. Can take the following values:
atlassianregular Atlassian user accountappsystem account used for Connect applications and OAuth to represent external systemscustomerJira Service Desk account representing an external service desk
- active? boolean - Whether the user is active
- groups? SimpleListWrapperGroupName - The groups that the user belongs to
- timeZone? string - The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned
- locale? string - The locale of the user. Depending on the user’s privacy setting, this may be returned as null
- accountId? string - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests
- emailAddress? string - The email address of the user. Depending on the user’s privacy setting, this may be returned as null
- expand? string - Expand options that include additional user details in the response
- name? string - This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details
- 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
- applicationRoles? SimpleListWrapperApplicationRole - The application roles the user is assigned to
jira: UserBean
Closed record
Fields
- 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
- displayName? string - The display name of the user. Depending on the user’s privacy setting, this may return an alternative value
- name? string - This property is deprecated in favor of
accountIdbecause of privacy changes. See the migration guide for details.
The username of the user
- active? boolean - Whether the user is active
- self? string - The URL of the user
- 'key? string - This property is deprecated in favor of
accountIdbecause of privacy changes. See the migration guide for details.
The key of the user
jira: UserBeanAvatarUrls
Closed record
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: UserContextVariable
A user specified as an Atlassian account ID
Fields
- accountId string - The account ID of the user
- 'type string - Type of custom context variable
jira: UserDetails
Closed record
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,
displayNameprovides 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,
accountIdreturns 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
- 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
- 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)
- name? string - This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details
- active? boolean - Whether the user is active
- self? string - The URL of the user
- timeZone? string - The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null
- 'key? string - This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details
jira: UserFilter
Filter for a User Picker (single) custom field
Fields
- roleIds? int[] - Roles that autocomplete suggestion users must belong to. If not provided, the default values are used. A maximum of 10 roles can be provided
- groups? string[] - User groups autocomplete suggestion users must belong to. If not provided, the default values are used. A maximum of 10 groups can be provided
- enabled boolean - Whether the filter is enabled
jira: UserKey
Closed record
List of user account IDs
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
- 'key? string - This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details
jira: UserList
Closed record
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? Signed32 - The number of items on the page
- endIndex? Signed32 - The index of the last item returned on the page
- maxResults? Signed32 - The maximum number of results that could be on the page
- startIndex? Signed32 - The index of the first item returned on the page
- items? User[] - The list of items
jira: UserMigrationBean
Closed record
Fields
- accountId? string -
- 'key? string -
- username? string -
jira: UserNavPropertyJsonBean
Closed record
Fields
- value? string -
- 'key? string -
jira: UserPermission
Details of a permission and its availability to a user
Fields
- 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.
- description? string - The description of the permission.
- havePermission? boolean - Whether the permission is available to the user in the queried context.
- id? string - The ID of the permission. Either
idorkeymust be specified. Use Get all permissions to get the list of permissions.
- 'key? string - The key of the permission. Either
idorkeymust be specified. Use Get all permissions to get the list of permissions.
- name? string - The name of the permission.
- 'type? "GLOBAL"|"PROJECT" - The type of the permission.
jira: UserPickerUser
Closed record
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
- avatarUrl? string - The avatar URL of the user
- displayName? string - The display name of the user. Depending on the user’s privacy setting, this may be returned as null
- accountType? "atlassian"|"app"|"customer"|"unknown" - The user account type. Can take the following values:
atlassianregular Atlassian user accountappsystem account used for Connect applications and OAuth to represent external systemscustomerJira Service Desk account representing an external service desk
- name? string - This property is no longer available . 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
- 'key? string - This property is no longer available. See the deprecation notice for details
jira: ValidateProjectKeyQueries
Represents the Queries record for the operation: validateProjectKey
Fields
- 'key? string - The project key
jira: ValidationOptionsForCreate
Closed record
The level of validation to return from the API. If no values are provided, the default would return WARNING and ERROR level validation results
Fields
- levels? ("WARNING"|"ERROR")[] -
jira: ValidationOptionsForUpdate
Closed record
The level of validation to return from the API. If no values are provided, the default would return WARNING and ERROR level validation results
Fields
- levels? ("WARNING"|"ERROR")[] -
jira: ValueOperand
An operand that is a user-provided value
Fields
- encodedValue? string - Encoded value, which can be used directly in a JQL query
- value string - The operand value
jira: Version
Closed record
Details about a project version
Fields
- releaseDate? string - The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version
- approvers? VersionApprover[] - If the expand option
approversis used, returns a list containing the approvers for this version
- description? string - The description of the version. Optional when creating or updating a version. The maximum size is 16,384 bytes
- project? string - Deprecated. Use
projectId
- archived? boolean - Indicates that the version is archived. Optional when creating or updating a version
- expand? string - Use expand to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include:
operationsReturns the list of operations available for this version.issuesstatusReturns 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.driverReturns the Atlassian account ID of the version driver.approversReturns a list containing approvers for this version.
- operations? SimpleLink[] - If the expand option
operationsis used, returns the list of operations available for this version
- driver? string - If the expand option
driveris used, returns the Atlassian account ID of the driver
- overdue? boolean - Indicates that the version is overdue
- name? string - The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters
- 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
- self? string - The URL of the version
- 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
- id? string - The ID of the version
- 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
- projectId? int - The ID of the project to which this version is attached. Required when creating a version. Not applicable when 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
- issuesStatusForFixVersion? VersionIssuesStatus - If the expand option
issuesstatusis 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: VersionApprover
Contains details about a version approver
Fields
- accountId? string - The Atlassian account ID of the approver.
- declineReason? string - A description of why the user is declining the approval.
- description? string - A description of what the user is approving within the specified version.
- status? string - The status of the approval, which can be PENDING, APPROVED, or DECLINED
jira: VersionIssueCounts
Closed record
Various counts of issues within a version
Fields
- issueCountWithCustomFieldsShowingVersion? int - Count of issues where a version custom field is set to the version
- customFieldUsage? VersionUsageInCustomField[] - List of custom fields using the version
- issuesAffectedCount? int - Count of issues where the
affectedVersionis set to the version
- issuesFixedCount? int - Count of issues where the
fixVersionis set to the version
- self? string - The URL of these count details
jira: VersionIssuesStatus
Counts of the number of issues in various statuses
Fields
- done? int - Count of issues with status done.
- inProgress? int - Count of issues with status in progress.
- toDo? int - Count of issues with status to do.
- unmapped? int - Count of issues with a status other than to do, in progress, and done.
jira: VersionMoveBean
Closed record
Fields
- after? string - The URL (self link) of the version after which to place the moved version. Cannot be used with
position
- position? "Earlier"|"Later"|"First"|"Last" - An absolute position in which to place the moved version. Cannot be used with
after
jira: VersionRelatedWork
Closed record
Associated related work to a version
Fields
- issueId? int - The ID of the issue associated with the related work (if there is one). Cannot be updated via the Rest API
- category string - The category of the related work
- title? string - The title of the related work
- url? string - The URL of the related work. Will be null for the native release note related work item, but is otherwise required
jira: VersionUnresolvedIssuesCount
Closed record
Count of a version's unresolved issues
Fields
- issuesUnresolvedCount? int - Count of unresolved issues
- self? string - The URL of these count details
- issuesCount? int - Count of issues
jira: VersionUsageInCustomField
Closed record
List of custom fields using the version
Fields
- fieldName? string - The name of the custom field
- issueCountWithVersionInCustomField? int - Count of the issues where the custom field contains the version
- customFieldId? int - The ID of the custom field
jira: Visibility
The group or role to which this item is visible
Fields
- identifier? string? - The ID of the group or the name of the role that visibility of this item is restricted to.
- 'type? "group"|"role" - Whether visibility of this item is restricted to a group or role.
- value? string - The name of the group or role that visibility of this item is restricted to. Please note that the name of a group is mutable, to reliably identify a group use
identifier.
jira: Votes
Closed record
The details of votes on an issue
Fields
- 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
- self? string - The URL of these issue vote details
- votes? int - The number of votes on the issue
jira: WarningCollection
Closed record
Fields
- warnings? string[] -
jira: Watchers
Closed record
The details of watchers on an issue
Fields
- self? string - The URL of these issue watcher details
- watchers? UserDetails[] - Details of the users watching this issue
- isWatching? boolean - Whether the calling user is watching this issue
- watchCount? Signed32 - The number of users watching this issue
jira: Webhook
Closed record
A webhook
Fields
- 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_updatedis sent. If this parameter is not present, the app is notified about all field updates
- id int - The ID of the webhook
- issuePropertyKeysFilter? string[] - A list of issue property keys. A change of those issue properties triggers the
issue_property_setorissue_property_deletedwebhooks. If this parameter is not present, the app is notified about all issue property updates
- events ("jira:issue_created"|"jira:issue_updated"|"jira:issue_deleted"|"comment_created"|"comment_updated"|"comment_deleted"|"issue_property_set"|"issue_property_deleted")[] - The Jira events that trigger the webhook
- url string - The URL that specifies where the webhooks are sent
- expirationDate? int - The date after which the webhook is no longer sent. Use Extend webhook life to extend the date
jira: WebhookDetails
Closed record
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, andcf[id]. For custom fields (cf[id]), only the epic label custom field is supported.". - Operators:
=,!=,IN, andNOT IN
- Fields:
- fieldIdsFilter? string[] - A list of field IDs. When the issue changelog contains any of the fields, the webhook
jira:issue_updatedis 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_setorissue_property_deletedwebhooks. If this parameter is not present, the app is notified about all issue property updates
- events ("jira:issue_created"|"jira:issue_updated"|"jira:issue_deleted"|"comment_created"|"comment_updated"|"comment_deleted"|"issue_property_set"|"issue_property_deleted")[] - The Jira events that trigger the webhook
jira: WebhookRegistrationDetails
Closed record
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. Only a single URL per app is allowed to be registered
jira: WebhooksExpirationDate
Closed record
The date the refreshed webhooks expire
Fields
- expirationDate int - The expiration date of all the refreshed webhooks
jira: Workflow
Closed record
Details about a workflow
Fields
- isDefault? boolean - Whether this is the default workflow
- operations? WorkflowOperations - Operations allowed on a workflow
- projects? ProjectDetails[] - The projects the workflow is assigned to, through workflow schemes
- hasDraftWorkflow? boolean - Whether the workflow has a draft version
- created? string - The creation date of the workflow
- description string - The description of the workflow
- statuses? WorkflowStatus[] - The statuses of the workflow
- id PublishedWorkflowId - Properties that identify a published workflow
- schemes? WorkflowSchemeIdName[] - The workflow schemes the workflow is assigned to
- transitions? Transition[] - The transitions of the workflow
- updated? string - The last edited date of the workflow
jira: WorkflowAssociationStatusMapping
Closed record
The list of status mappings
Fields
- oldStatusId string - The ID of the status in the old workflow that isn't present in the new workflow
- newStatusId string - The ID of the status in the new workflow
jira: WorkflowCapabilities
Closed record
Fields
- systemRules? AvailableWorkflowSystemRule[] - The Atlassian provided system rules available
- triggerRules? AvailableWorkflowTriggers[] - The trigger rules available
- connectRules? AvailableWorkflowConnectRule[] - The Connect provided ecosystem rules available
- editorScope? "PROJECT"|"GLOBAL" - The scope of the workflow capabilities.
GLOBALfor company-managed projects andPROJECTfor team-managed projects
- projectTypes? ("software"|"service_desk"|"product_discovery"|"business"|"unknown")[] - The types of projects that this capability set is available for
- forgeRules? AvailableWorkflowForgeRule[] - The Forge provided ecosystem rules available
jira: WorkflowCapabilitiesQueries
Represents the Queries record for the operation: workflowCapabilities
Fields
- issueTypeId? string -
- projectId? string -
- workflowId? string -
jira: WorkflowCapabilityPayload
Closed record
The payload for creating a workflows. See https://www.atlassian.com/software/jira/guides/workflows/overview\#what-is-a-jira-workflow
Fields
- statuses? StatusPayload[] - The statuses for the workflow
- workflows? WorkflowPayload[] - The transitions for the workflow
- workflowScheme? WorkflowSchemePayload - The payload for creating a workflow scheme. See https://www.atlassian.com/software/jira/guides/workflows/overview#what-is-a-jira-workflow-scheme
jira: WorkflowCompoundCondition
A compound workflow transition rule condition. This object returns nodeType as compound
Fields
- conditions WorkflowCondition[] - The list of workflow conditions
- nodeType string -
- operator "AND"|"OR" - The compound condition operator
jira: WorkflowCreate
Closed record
The details of the workflows to create
Fields
- startPointLayout? WorkflowLayout? - The starting point for the statuses in the workflow
- loopedTransitionContainerLayout? WorkflowLayout? - The starting point for the statuses in the workflow
- name string - The name of the workflow to create
- description? string - The description of the workflow to create
- statuses StatusLayoutUpdate[] - The statuses associated with this workflow
- transitions TransitionUpdateDTO[] - The transitions of this workflow
jira: WorkflowCreateRequest
Closed record
The create workflows payload
Fields
- scope? WorkflowScope - The scope of the workflow
- statuses? WorkflowStatusUpdate[] - The statuses to associate with the workflows
- workflows? WorkflowCreate[] - The details of the workflows to create
jira: WorkflowCreateResponse
Closed record
Details of the created workflows and statuses
Fields
- statuses? JiraWorkflowStatus[] - List of created statuses
- workflows? JiraWorkflow[] - List of created workflows
jira: WorkflowCreateValidateRequest
Closed record
Fields
- validationOptions? ValidationOptionsForCreate - The level of validation to return from the API. If no values are provided, the default would return
WARNINGandERRORlevel validation results
- payload WorkflowCreateRequest - The create workflows payload
jira: WorkflowElementReference
Closed record
A reference to the location of the error. This will be null if the error does not refer to a specific element
Fields
- propertyKey? string - A property key
- statusMappingReference? ProjectAndIssueTypePair - A project and issueType ID pair that identifies a status mapping
- transitionId? string - A transition ID
- ruleId? string - A rule ID
- statusReference? string - A status reference
jira: WorkflowId
Closed record
Properties that identify a workflow
Fields
- draft boolean - Whether the workflow is in the draft state
- name string - The name of the workflow
jira: WorkflowIDs
Closed record
The classic workflow identifiers
Fields
- name string - The name of the workflow
- entityId? string - The entity ID of the workflow
jira: WorkflowLayout
Closed record
The starting point for the statuses in the workflow
Fields
- x? decimal - The x axis location
- y? decimal - The y axis location
jira: WorkflowMetadataAndIssueTypeRestModel
Closed record
The workflow metadata and issue type IDs which use this workflow
Fields
- workflow WorkflowMetadataRestModel - Workflow metadata and usage detail
- issueTypeIds string[] - The list of issue type IDs for the mapping
jira: WorkflowMetadataRestModel
Closed record
Workflow metadata and usage detail
Fields
- usage SimpleUsage[]? - Deprecated. See the deprecation notice for details.
Use the optional
workflows.usagesexpand to get additional information about the projects and issue types associated with the workflows in the workflow scheme
- name string - The name of the workflow
- description string - The description of the workflow
- id string - The ID of the workflow
- version DocumentVersion - The current version details of this workflow scheme
jira: WorkflowOperations
Closed record
Operations allowed on a workflow
Fields
- canEdit boolean - Whether the workflow can be updated
- canDelete boolean - Whether the workflow can be deleted
jira: WorkflowPayload
Closed record
The payload for creating workflow, see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows/\#api-rest-api-3-workflows-create-post
Fields
- startPointLayout? WorkflowStatusLayoutPayload - The layout of the workflow status
- onConflict "FAIL"|"USE"|"NEW" (default "NEW") - The strategy to use if there is a conflict with another workflow
- loopedTransitionContainerLayout? WorkflowStatusLayoutPayload - The layout of the workflow status
- name? string - The name of the workflow
- description? string - The description of the workflow
- statuses? WorkflowStatusPayload[] - The statuses to be used in the workflow
- transitions? TransitionPayload[] - The transitions for the workflow
- pcri? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
jira: WorkflowProjectIssueTypeUsage
Closed record
The issue type
Fields
- id? string - The ID of the issue type
jira: WorkflowProjectIssueTypeUsageDTO
Closed record
Issue types associated with the workflow for a project
Fields
- projectId? string - The ID of the project
- workflowId? string - The ID of the workflow
- issueTypes? WorkflowProjectIssueTypeUsagePage - A page of issue types
jira: WorkflowProjectIssueTypeUsagePage
Closed record
A page of issue types
Fields
- nextPageToken? string - Token for the next page of issue type usages
- values? WorkflowProjectIssueTypeUsage[] - The list of issue types
jira: WorkflowProjectUsageDTO
Closed record
Projects using the workflow
Fields
- projects? ProjectUsagePage - A page of projects
- workflowId? string - The workflow ID
jira: WorkflowReadRequest
Closed record
Fields
- workflowNames? string[] - The list of workflow names to query
- workflowIds? string[] - The list of workflow IDs to query
- projectAndIssueTypes? ProjectAndIssueTypePair[] - The list of projects and issue types to query
jira: WorkflowReadResponse
Closed record
Details of workflows and related statuses
Fields
- statuses? JiraWorkflowStatus[] - List of statuses
- workflows? JiraWorkflow[] - List of workflows
jira: WorkflowReferenceStatus
Closed record
The statuses referenced in the workflow
Fields
- layout? WorkflowStatusLayout? - The x and y location of the status in the workflow
- deprecated? boolean - Indicates if the status is deprecated
- statusReference? string - The reference of the status
- approvalConfiguration? ApprovalConfiguration? - The approval configuration of a status within a workflow. Applies only to Jira Service Management approvals
- properties? record { string... } - The properties associated with the status
jira: WorkflowRuleConfiguration
Closed record
The configuration of the rule
Fields
- id? string? - The ID of the rule
- parameters? record { string... } - The parameters related to the rule
- ruleKey string - The rule key of the rule
jira: WorkflowRules
Closed record
A collection of transition rules
Fields
- conditionsTree? WorkflowCondition - The workflow transition rule conditions tree
- postFunctions? WorkflowTransitionRule[] - The workflow post functions
- validators? WorkflowTransitionRule[] - The workflow validators
jira: WorkflowRulesSearch
Details of the workflow and its transition rules
Fields
- expand? string - Use expand to include additional information in the response. This parameter accepts
transitionwhich, for each rule, returns information about the transition the rule is assigned to
- ruleIds string[] - The list of workflow rule IDs
- workflowEntityId string - The workflow ID
jira: WorkflowRulesSearchDetails
Details of workflow transition rules
Fields
- invalidRules? string[] - List of workflow rule IDs that do not belong to the workflow or can not be found
- validRules? WorkflowTransitionRules[] - List of valid workflow transition rules
- workflowEntityId? string - The workflow ID
jira: WorkflowScheme
Closed record
Details about a workflow scheme
Fields
- 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
- description? string - The description of the workflow scheme
- issueTypes? record { IssueTypeDetails... } - The issue types available in Jira
- originalIssueTypeMappings? record { string... } - 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
- 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
defaultWorkflowis not specified when creating a workflow scheme, it is set to Jira Workflow (jira)
- 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
updateDraftIfNeededset totrue: If a draft workflow scheme exists, it is updated. Otherwise, a draft workflow scheme is created. - Update an active workflow scheme with
updateDraftIfNeededset tofalse: An error is returned, as active workflow schemes cannot be updated. - Update an inactive workflow scheme with
updateDraftIfNeededset totrue: The workflow scheme is updated, as inactive workflow schemes do not require drafts to update.
false - Update an active workflow scheme with
- draft? boolean - Whether the workflow scheme is a draft or not
- 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
- self? string -
- 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
- id? int - The ID of the workflow scheme
- 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
- issueTypeMappings? record { string... } - 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
jira: WorkflowSchemeAssociation
Closed record
The explicit association between issue types and a workflow in a workflow scheme
Fields
- issueTypeIds string[] - The issue types assigned to the workflow
- workflowId string - The ID of the workflow
jira: WorkflowSchemeAssociations
Closed record
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: WorkflowSchemeIdName
Closed record
The ID and the name of the workflow scheme
Fields
- name string - The name of the workflow scheme
- id string - The ID of the workflow scheme
jira: WorkflowSchemePayload
Closed record
The payload for creating a workflow scheme. See https://www.atlassian.com/software/jira/guides/workflows/overview\#what-is-a-jira-workflow-scheme
Fields
- defaultWorkflow? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
- name? string - The name of the workflow scheme
- description? string - The description of the workflow scheme
- pcri? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
- explicitMappings? record { ProjectCreateResourceIdentifier... } - Association between issuetypes and workflows
jira: WorkflowSchemeProjectAssociation
Closed record
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: WorkflowSchemeProjectUsageDTO
Closed record
Projects using the workflow scheme
Fields
- projects? ProjectUsagePage - A page of projects
- workflowSchemeId? string - The workflow scheme ID
jira: WorkflowSchemeReadRequest
Closed record
The workflow scheme read request body
Fields
- workflowSchemeIds? string[]? - The list of workflow scheme IDs to query
- projectIds? string[]? - The list of project IDs to query
jira: WorkflowSchemeReadResponse
Closed record
Fields
- defaultWorkflow? WorkflowMetadataRestModel - Workflow metadata and usage detail
- workflowsForIssueTypes WorkflowMetadataAndIssueTypeRestModel[] - Mappings from workflows to issue types
- scope WorkflowScope - The scope of the workflow
- name string - The name of the workflow scheme
- description? string? - The description of the workflow scheme
- projectIdsUsingScheme? string[]? - Deprecated. See the deprecation notice for details. The IDs of projects using the workflow scheme
- id string - The ID of the workflow scheme
- version DocumentVersion - The current version details of this workflow scheme
- taskId? string? - Indicates if there's an asynchronous task for this workflow scheme
jira: WorkflowSchemeUpdateRequest
The update workflow scheme payload
Fields
- defaultWorkflowId? string - The ID of the workflow for issue types without having a mapping defined in this workflow scheme. Only used in global-scoped workflow schemes. If the
defaultWorkflowIdisn't specified, this is set to Jira Workflow (jira).
- description string - The new description for this workflow scheme.
- id string - The ID of this workflow scheme.
- name string - The new name for this workflow scheme.
- statusMappingsByIssueTypeOverride? MappingsByIssueTypeOverride[] - Overrides, for the selected issue types, any status mappings provided in
statusMappingsByWorkflows. Status mappings are required when the new workflow for an issue type doesn't contain all statuses that the old workflow has. Status mappings can be provided by a combination ofstatusMappingsByWorkflowsandstatusMappingsByIssueTypeOverride.
- statusMappingsByWorkflows? MappingsByWorkflow[] - The status mappings by workflows. Status mappings are required when the new workflow for an issue type doesn't contain all statuses that the old workflow has. Status mappings can be provided by a combination of
statusMappingsByWorkflowsandstatusMappingsByIssueTypeOverride.
- version DocumentVersion - The current version details of this workflow scheme
- workflowsForIssueTypes? WorkflowSchemeAssociation[] - Mappings from workflows to issue types.
jira: WorkflowSchemeUpdateRequiredMappingsRequest
Closed record
The request payload to get the required mappings for updating a workflow scheme
Fields
- defaultWorkflowId? string? - The ID of the new default workflow for this workflow scheme. Only used in global-scoped workflow schemes. If it isn't specified, is set to Jira Workflow (jira)
- workflowsForIssueTypes WorkflowSchemeAssociation[] - The new workflow to issue type mappings for this workflow scheme
- id string - The ID of the workflow scheme
jira: WorkflowSchemeUpdateRequiredMappingsResponse
Closed record
Fields
- statuses? StatusMetadata[] - The details of the statuses in the associated workflows
- statusMappingsByWorkflows? RequiredMappingByWorkflows[] - The list of required status mappings by workflow
- statusMappingsByIssueTypes? RequiredMappingByIssueType[] - The list of required status mappings by issue type
- statusesPerWorkflow? StatusesPerWorkflow[] - The statuses associated with each workflow
jira: WorkflowSchemeUsage
Closed record
The worflow scheme
Fields
- id? string - The workflow scheme ID
jira: WorkflowSchemeUsageDTO
Closed record
Workflow schemes using the workflow
Fields
- workflowSchemes? WorkflowSchemeUsagePage - A page of workflow schemes
- workflowId? string - The workflow ID
jira: WorkflowSchemeUsagePage
Closed record
A page of workflow schemes
Fields
- nextPageToken? string - Token for the next page of issue type usages
- values? WorkflowSchemeUsage[] - The list of workflow schemes
jira: WorkflowScope
Closed record
The scope of the workflow
Fields
- project? ProjectId? - Project ID details
- 'type? "PROJECT"|"GLOBAL" - The scope of the workflow.
GLOBALfor company-managed projects andPROJECTfor team-managed projects
jira: WorkflowSearchResponse
Closed record
Page of items, including workflows and related statuses
Fields
- total? int - The number of items returned
- isLast? boolean - Whether this is the last page
- maxResults? Signed32 - The maximum number of items that could be returned
- nextPage? string - If there is another page of results, the URL of the next page
- values? JiraWorkflow[] - List of workflows
- self? string - The URL of the page
- statuses? JiraWorkflowStatus[] - List of statuses
- startAt? int - The index of the first item returned
jira: WorkflowSimpleCondition
A workflow transition rule condition. This object returns nodeType as simple
Fields
- configuration? record {} - EXPERIMENTAL. The configuration of the transition rule
- nodeType string -
- 'type string - The type of the transition rule
jira: WorkflowStatus
Closed record
Details of a workflow status
Fields
- name string - The name of the status in the workflow
- id string - The ID of the issue status
- properties? record {} - Additional properties that modify the behavior of issues in this status. Supports the properties
jira.issue.editableandissueEditable(deprecated) that indicate whether issues are editable
jira: WorkflowStatusLayout
Closed record
The x and y location of the status in the workflow
Fields
- x? decimal? - The x axis location
- y? decimal? - The y axis location
jira: WorkflowStatusLayoutPayload
Closed record
The layout of the workflow status
Fields
- x? decimal - The x coordinate of the status
- y? decimal - The y coordinate of the status
jira: WorkflowStatusPayload
Closed record
The statuses to be used in the workflow
Fields
- layout? WorkflowStatusLayoutPayload - The layout of the workflow status
- pcri? ProjectCreateResourceIdentifier - Every project-created entity has an ID that must be unique within the scope of the project creation. PCRI (Project Create Resource Identifier) is a standard format for creating IDs and references to other project entities. PCRI format is defined as follows: pcri:[entityType]:[type]:[entityId] entityType - the type of an entity, e.g. status, role, workflow type - PCRI type, either
id- The ID of an entity that already exists in the target site, orref- A unique reference to an entity that is being created entityId - entity identifier, if type isid- must be an existing entity ID that exists in the Jira site, ifref- must be unique across all entities in the scope of this project template creation
- properties? record { string... } - The properties of the workflow status
jira: WorkflowStatusUpdate
Details of the status being updated
Fields
- description? string - The description of the status.
- id? string - The ID of the status.
- name string - The name of the status.
- statusCategory "TODO"|"IN_PROGRESS"|"DONE" - The category of the status.
- statusReference string - The reference of the status.
jira: WorkflowsWithTransitionRulesDetails
Closed record
Details of workflows and their transition rules to delete
Fields
- workflows WorkflowTransitionRulesDetails[] - The list of workflows with transition rules to delete
jira: WorkflowTransition
Closed record
A workflow transition
Fields
- name string - The transition name
- id Signed32 - The transition ID
jira: WorkflowTransitionLinks
Closed record
The statuses the transition can start from, and the mapping of ports between the statuses
Fields
- fromPort? Signed32? - The port that the transition starts from
- toPort? Signed32? - The port that the transition goes to
- fromStatusReference? string? - The status that the transition starts from
jira: WorkflowTransitionProperty
Details about the server Jira is running on
Fields
- id? string - The ID of the transition property.
- '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.
jira: WorkflowTransitionRule
Closed record
A workflow transition rule
Fields
- configuration? anydata - EXPERIMENTAL. The configuration of the transition rule
- 'type string - The type of the transition rule
jira: WorkflowTransitionRules
Closed record
A workflow with transition rules
Fields
- postFunctions? AppWorkflowTransitionRule[] - The list of post functions within the workflow
- validators? AppWorkflowTransitionRule[] - The list of validators within the workflow
- conditions? AppWorkflowTransitionRule[] - The list of conditions within the workflow
- workflowId WorkflowId - Properties that identify a workflow
jira: WorkflowTransitionRulesDetails
Closed record
Details about a workflow configuration update request
Fields
- workflowRuleIds string[] - The list of connect workflow rule IDs
- workflowId WorkflowId - Properties that identify a workflow
jira: WorkflowTransitionRulesUpdate
Closed record
Details about a workflow configuration update request
Fields
- workflows WorkflowTransitionRules[] - The list of workflows with transition rules to update
jira: WorkflowTransitionRulesUpdateErrorDetails
Closed record
Details of any errors encountered while updating workflow transition rules for a workflow
Fields
- updateErrors string[] - The list of errors that specify why the workflow update failed. The workflow was not updated if the list contains any entries
- workflowId WorkflowId - Properties that identify a workflow
- ruleUpdateErrors record { string[]... } - A list of transition rule update errors, indexed by the transition rule ID. Any transition rule that appears here wasn't updated
jira: WorkflowTransitionRulesUpdateErrors
Closed record
Details of any errors encountered while updating workflow transition rules
Fields
- updateResults WorkflowTransitionRulesUpdateErrorDetails[] - A list of workflows
jira: WorkflowTransitions
Closed record
The transitions of the workflow
Fields
- validators? WorkflowRuleConfiguration[] - The validators of the transition
- description? string - The description of the transition
- triggers? WorkflowTrigger[] - The triggers of the transition
- 'type? "INITIAL"|"GLOBAL"|"DIRECTED" - The transition type
- customIssueEventId? string? - The custom event ID of the transition
- toStatusReference? string - The status the transition goes to
- transitionScreen? WorkflowRuleConfiguration? - The configuration of the rule
- name? string - The name of the transition
- links? WorkflowTransitionLinks[] - The statuses the transition can start from, and the mapping of ports between the statuses
- id? string - The ID of the transition
- conditions? ConditionGroupConfiguration? - The conditions group associated with the transition
- actions? WorkflowRuleConfiguration[] - The post-functions of the transition
- properties? record { string... } - The properties of the transition
jira: WorkflowTrigger
Closed record
The trigger configuration associated with a workflow
Fields
- id? string - The ID of the trigger
- parameters record { string... } - The parameters of the trigger
- ruleKey string - The rule key of the trigger
jira: WorkflowUpdate
The details of the workflows to update
Fields
- defaultStatusMappings? StatusMigration[] - The mapping of old to new status ID.
- description? string - The new description for this workflow.
- id string - The ID of this workflow.
- loopedTransitionContainerLayout? WorkflowLayout? - The starting point for the statuses in the workflow
- startPointLayout? WorkflowLayout? - The starting point for the statuses in the workflow
- statusMappings? StatusMappingDTO[] - The mapping of old to new status ID for a specific project and issue type.
- statuses StatusLayoutUpdate[] - The statuses associated with this workflow.
- transitions TransitionUpdateDTO[] - The transitions of this workflow.
- version DocumentVersion - The current version details of this workflow scheme
jira: WorkflowUpdateRequest
Closed record
The update workflows payload
Fields
- statuses? WorkflowStatusUpdate[] - The statuses to associate with the workflows
- workflows? WorkflowUpdate[] - The details of the workflows to update
jira: WorkflowUpdateResponse
Closed record
Fields
- statuses? JiraWorkflowStatus[] - List of updated statuses
- workflows? JiraWorkflow[] - List of updated workflows
- taskId? string? - If there is a asynchronous task operation, as a result of this update
jira: WorkflowUpdateValidateRequestBean
Closed record
Fields
- validationOptions? ValidationOptionsForUpdate - The level of validation to return from the API. If no values are provided, the default would return
WARNINGandERRORlevel validation results
- payload WorkflowUpdateRequest - The update workflows payload
jira: WorkflowUsages
Closed record
Deprecated. See the deprecation notice for details.
The workflows that use this status. Only available if the workflowUsages expand is requested
Fields
- workflowName? string - Workflow name
- workflowId? string - Workflow ID
jira: WorkflowValidationError
Closed record
The details about a workflow validation error
Fields
- code? string - An error code
- level? "WARNING"|"ERROR" - The validation error level
- elementReference? WorkflowElementReference - A reference to the location of the error. This will be null if the error does not refer to a specific element
- message? string - An error message
- 'type? "RULE"|"STATUS"|"STATUS_LAYOUT"|"STATUS_PROPERTY"|"WORKFLOW"|"TRANSITION"|"TRANSITION_PROPERTY"|"SCOPE"|"STATUS_MAPPING"|"TRIGGER" - The type of element the error or warning references
jira: WorkflowValidationErrorList
Closed record
Fields
- errors? WorkflowValidationError[] - The list of validation errors
jira: WorkingDaysConfig
Closed record
Working days configuration
Fields
- sunday? boolean -
- saturday? boolean -
- nonWorkingDays? NonWorkingDay[] -
- tuesday? boolean -
- friday? boolean -
- thursday? boolean -
- timezoneId? string -
- wednesday? boolean -
- id? int -
- monday? boolean -
jira: Worklog
Details of a worklog
Fields
- comment? anydata - A comment about the worklog in Atlassian Document Format. Optional when creating or updating a worklog.
- created? string - The datetime on which the worklog was created.
- 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.
- self? string - The URL of the worklog item.
- 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
timeSpentSecondsisn't provided. Optional when updating a worklog. Cannot be provided iftimeSpentSecondis provided.
- timeSpentSeconds? int - The time in seconds spent working on the issue. Required when creating a worklog if
timeSpentisn't provided. Optional when updating a worklog. Cannot be provided iftimeSpentis provided.
- updateAuthor? UserDetails - Details of the user who last updated the worklog.
- 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.
jira: WorklogIdsRequestBean
Closed record
Fields
- ids int[] - A list of worklog IDs
jira: WorklogsMoveRequestBean
Closed record
Fields
- issueIdOrKey? string - The issue id or key of the destination issue
- ids? int[] - A list of worklog IDs
jira: WorkspaceDataPolicy
Closed record
Details about data policy
Fields
- anyContentBlocked? boolean - Whether the workspace contains any content inaccessible to the requesting application
Union types
jira: WorkflowCondition
WorkflowCondition
The workflow transition rule conditions tree
jira: JqlQueryUnitaryOperand
JqlQueryUnitaryOperand
An operand that can be part of a list operand
jira: JqlQueryClauseOperand
JqlQueryClauseOperand
Details of an operand in a JQL clause
jira: CustomContextVariable
CustomContextVariable
jira: JqlQueryClause
JqlQueryClause
A JQL query clause
jira: CustomFieldContextDefaultValue
CustomFieldContextDefaultValue
String types
jira: BulkGetUsersQueriesAccountIdItemsString
BulkGetUsersQueriesAccountIdItemsString
jira: GetWorkflowTransitionRuleConfigurationsQueriesWithTagsItemsString
GetWorkflowTransitionRuleConfigurationsQueriesWithTagsItemsString
jira: GetWorkflowTransitionRuleConfigurationsQueriesWorkflowNamesItemsString
GetWorkflowTransitionRuleConfigurationsQueriesWorkflowNamesItemsString
jira: JqlQueriesToParseQueriesItemsString
JqlQueriesToParseQueriesItemsString
jira: GetUserEmailBulkQueriesAccountIdItemsString
GetUserEmailBulkQueriesAccountIdItemsString
Integer types
jira: CreatePrioritySchemeDetailsPriorityIdsItemsInteger
CreatePrioritySchemeDetailsPriorityIdsItemsInteger