;
+ };
+ valueNames?: string[];
+ };
+ trailerFields?: {
+ [key: string]: string;
+ };
+ trailerFieldsReady?: boolean;
+ userPrincipal?: {
+ name?: string;
+ };
+ };
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["PageBeanWorkflowTransitionRules"];
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: {
+ "application/json": components["schemas"]["ErrorCollection"];
+ };
+ };
+ /** @description Returned if the caller is not a Connect or Forge app. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorCollection"];
+ };
+ };
+ /** @description Returned if any transition rule type is not supported. */
+ 404: {
+ content: never;
+ };
+ /** @description Returned if we encounter a problem while trying to access the required data. */
+ 503: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Update workflow transition rule configurations
+ * @description Updates configuration of workflow transition rules. The following rule types are supported:
+ *
+ * * [post functions](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-post-function/)
+ * * [conditions](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-condition/)
+ * * [validators](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-validator/)
+ *
+ * Only rules created by the calling [Connect](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps) or [Forge](https://developer.atlassian.com/cloud/jira/platform/index/#forge-apps) app can be updated.
+ *
+ * To assist with app migration, this operation can be used to:
+ *
+ * * Disable a rule.
+ * * Add a `tag`. Use this to filter rules in the [Get workflow transition rule configurations](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-transition-rules/#api-rest-api-3-workflow-rule-config-get).
+ *
+ * Rules are enabled if the `disabled` parameter is not provided.
+ *
+ * **[Permissions](#permissions) required:** Only [Connect](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps) or [Forge](https://developer.atlassian.com/cloud/jira/platform/index/#forge-apps) apps can use this operation.
+ */
+ updateWorkflowTransitionRuleConfigurations: {
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "workflows": [
+ * {
+ * "conditions": [
+ * {
+ * "configuration": {
+ * "disabled": false,
+ * "tag": "Another tag",
+ * "value": "{ \"size\": \"medium\" }"
+ * },
+ * "id": "d663bd873d93-59f5-11e9-8647-b4d6cbdc"
+ * }
+ * ],
+ * "postFunctions": [
+ * {
+ * "configuration": {
+ * "disabled": false,
+ * "tag": "Sample tag",
+ * "value": "{ \"color\": \"red\" }"
+ * },
+ * "id": "b4d6cbdc-59f5-11e9-8647-d663bd873d93"
+ * }
+ * ],
+ * "validators": [
+ * {
+ * "configuration": {
+ * "disabled": false,
+ * "value": "{ \"shape\": \"square\" }"
+ * },
+ * "id": "11e9-59f5-b4d6cbdc-8647-d663bd873d93"
+ * }
+ * ],
+ * "workflowId": {
+ * "draft": false,
+ * "name": "My Workflow name"
+ * }
+ * }
+ * ]
+ * }
+ */
+ "application/json": components["schemas"]["WorkflowTransitionRulesUpdate"];
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["WorkflowTransitionRulesUpdateErrors"];
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: {
+ "application/json": components["schemas"]["ErrorCollection"];
+ };
+ };
+ /** @description Returned if the caller is not a Connect or Forge app. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorCollection"];
+ };
+ };
+ /** @description Returned if we encounter a problem while trying to access the required data. */
+ 503: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Delete workflow transition rule configurations
+ * @description Deletes workflow transition rules from one or more workflows. These rule types are supported:
+ *
+ * * [post functions](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-post-function/)
+ * * [conditions](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-condition/)
+ * * [validators](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-validator/)
+ *
+ * Only rules created by the calling Connect app can be deleted.
+ *
+ * **[Permissions](#permissions) required:** Only Connect apps can use this operation.
+ */
+ deleteWorkflowTransitionRuleConfigurations: {
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "workflows": [
+ * {
+ * "workflowId": {
+ * "draft": false,
+ * "name": "Internal support workflow"
+ * },
+ * "workflowRuleIds": [
+ * "b4d6cbdc-59f5-11e9-8647-d663bd873d93",
+ * "d663bd873d93-59f5-11e9-8647-b4d6cbdc",
+ * "11e9-59f5-b4d6cbdc-8647-d663bd873d93"
+ * ]
+ * }
+ * ]
+ * }
+ */
+ "application/json": components["schemas"]["WorkflowsWithTransitionRulesDetails"];
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["WorkflowTransitionRulesUpdateErrors"];
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: {
+ "application/json": components["schemas"]["ErrorCollection"];
+ };
+ };
+ /** @description Returned if the caller is not a Connect app. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorCollection"];
+ };
+ };
+ };
+ };
+ /**
+ * Get workflows paginated
+ * @description Returns a [paginated](#pagination) list of published classic workflows. When workflow names are specified, details of those workflows are returned. Otherwise, all published classic workflows are returned.
+ *
+ * This operation does not return next-gen workflows.
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ getWorkflowsPaginated: {
+ parameters: {
+ query?: {
+ /** @description The index of the first item to return in a page of results (page offset). */
+ startAt?: number;
+ /** @description The maximum number of items to return per page. */
+ maxResults?: number;
+ /** @description The name of a workflow to return. To include multiple workflows, provide an ampersand-separated list. For example, `workflowName=name1&workflowName=name2`. */
+ workflowName?: string[];
+ /**
+ * @description Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:
+ *
+ * * `transitions` For each workflow, returns information about the transitions inside the workflow.
+ * * `transitions.rules` For each workflow transition, returns information about its rules. Transitions are included automatically if this expand is requested.
+ * * `transitions.properties` For each workflow transition, returns information about its properties. Transitions are included automatically if this expand is requested.
+ * * `statuses` For each workflow, returns information about the statuses inside the workflow.
+ * * `statuses.properties` For each workflow status, returns information about its properties. Statuses are included automatically if this expand is requested.
+ * * `default` For each workflow, returns information about whether this is the default workflow.
+ * * `schemes` For each workflow, returns information about the workflow schemes the workflow is assigned to.
+ * * `projects` For each workflow, returns information about the projects the workflow is assigned to, through workflow schemes.
+ * * `hasDraftWorkflow` For each workflow, returns information about whether the workflow has a draft version.
+ * * `operations` For each workflow, returns information about the actions that can be undertaken on the workflow.
+ */
+ expand?: string;
+ /** @description String used to perform a case-insensitive partial match with workflow name. */
+ queryString?: string;
+ /**
+ * @description [Order](#ordering) the results by a field:
+ *
+ * * `name` Sorts by workflow name.
+ * * `created` Sorts by create time.
+ * * `updated` Sorts by update time.
+ */
+ orderBy?:
+ | "name"
+ | "-name"
+ | "+name"
+ | "created"
+ | "-created"
+ | "+created"
+ | "updated"
+ | "+updated"
+ | "-updated";
+ /** @description Filters active and inactive workflows. */
+ isActive?: boolean;
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["PageBeanWorkflow"];
+ };
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the necessary permission. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorCollection"];
+ };
+ };
+ };
+ };
+ /**
+ * Get workflow transition properties
+ * @description Returns the properties on a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see [Transition properties](https://confluence.atlassian.com/x/zIhKLg#Advancedworkflowconfiguration-transitionproperties) and [Workflow properties](https://confluence.atlassian.com/x/JYlKLg).
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ getWorkflowTransitionProperties: {
+ parameters: {
+ query: {
+ /** @description 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*. */
+ includeReservedKeys?: boolean;
+ /** @description 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. */
+ key?: string;
+ /** @description The name of the workflow that the transition belongs to. */
+ workflowName: string;
+ /** @description The workflow status. Set to *live* for active and inactive workflows, or *draft* for draft workflows. */
+ workflowMode?: "live" | "draft";
+ };
+ path: {
+ /** @description The ID of the transition. To get the ID, view the workflow in text mode in the Jira administration console. The ID is shown next to the transition. */
+ transitionId: number;
+ };
+ };
+ responses: {
+ /** @description 200 response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["WorkflowTransitionProperty"];
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have admin permission */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the workflow transition or property is not found. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Update workflow transition property
+ * @description Updates a workflow transition by changing the property value. Trying to update a property that does not exist results in a new property being added to the transition. Transition properties are used to change the behavior of a transition. For more information, see [Transition properties](https://confluence.atlassian.com/x/zIhKLg#Advancedworkflowconfiguration-transitionproperties) and [Workflow properties](https://confluence.atlassian.com/x/JYlKLg).
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ updateWorkflowTransitionProperty: {
+ parameters: {
+ query: {
+ /** @description The key of the property being updated, also known as the name of the property. Set this to the same value as the `key` defined in the request body. */
+ key: string;
+ /** @description The name of the workflow that the transition belongs to. */
+ workflowName: string;
+ /** @description The workflow status. Set to `live` for inactive workflows or `draft` for draft workflows. Active workflows cannot be edited. */
+ workflowMode?: "live" | "draft";
+ };
+ path: {
+ /** @description The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition. */
+ transitionId: number;
+ };
+ };
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "value": "createissue"
+ * }
+ */
+ "application/json": components["schemas"]["WorkflowTransitionProperty"];
+ };
+ };
+ responses: {
+ /** @description 200 response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["WorkflowTransitionProperty"];
+ };
+ };
+ /** @description Returned if no changes were made by the request. For example, attempting to update a property with its current value. */
+ 304: {
+ content: never;
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the necessary permission. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the workflow transition is not found. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Create workflow transition property
+ * @description Adds a property to a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see [Transition properties](https://confluence.atlassian.com/x/zIhKLg#Advancedworkflowconfiguration-transitionproperties) and [Workflow properties](https://confluence.atlassian.com/x/JYlKLg).
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ createWorkflowTransitionProperty: {
+ parameters: {
+ query: {
+ /** @description The key of the property being added, also known as the name of the property. Set this to the same value as the `key` defined in the request body. */
+ key: string;
+ /** @description The name of the workflow that the transition belongs to. */
+ workflowName: string;
+ /** @description The workflow status. Set to *live* for inactive workflows or *draft* for draft workflows. Active workflows cannot be edited. */
+ workflowMode?: "live" | "draft";
+ };
+ path: {
+ /** @description The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition. */
+ transitionId: number;
+ };
+ };
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "value": "createissue"
+ * }
+ */
+ "application/json": components["schemas"]["WorkflowTransitionProperty"];
+ };
+ };
+ responses: {
+ /** @description 200 response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["WorkflowTransitionProperty"];
+ };
+ };
+ /** @description Returned if a workflow property with the same key is present on the transition. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the necessary permission. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the workflow transition is not found. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Delete workflow transition property
+ * @description Deletes a property from a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see [Transition properties](https://confluence.atlassian.com/x/zIhKLg#Advancedworkflowconfiguration-transitionproperties) and [Workflow properties](https://confluence.atlassian.com/x/JYlKLg).
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ deleteWorkflowTransitionProperty: {
+ parameters: {
+ query: {
+ /** @description The name of the transition property to delete, also known as the name of the property. */
+ key: string;
+ /** @description The name of the workflow that the transition belongs to. */
+ workflowName: string;
+ /** @description The workflow status. Set to `live` for inactive workflows or `draft` for draft workflows. Active workflows cannot be edited. */
+ workflowMode?: "live" | "draft";
+ };
+ path: {
+ /** @description The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition. */
+ transitionId: number;
+ };
+ };
+ responses: {
+ /** @description 200 response */
+ 200: {
+ content: never;
+ };
+ /** @description Returned if no changes were made by the request. For example, trying to delete a property that cannot be found. */
+ 304: {
+ content: never;
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the necessary permission. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the workflow transition is not found. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Delete inactive workflow
+ * @description Deletes a workflow.
+ *
+ * The workflow cannot be deleted if it is:
+ *
+ * * an active workflow.
+ * * a system workflow.
+ * * associated with any workflow scheme.
+ * * associated with any draft workflow scheme.
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ deleteInactiveWorkflow: {
+ parameters: {
+ path: {
+ /** @description The entity ID of the workflow. */
+ entityId: string;
+ };
+ };
+ responses: {
+ /** @description Returned if the workflow is deleted. */
+ 204: {
+ content: never;
+ };
+ /** @description Returned if the request is not valid. */
+ 400: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the required permissions. */
+ 403: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the workflow is not found. */
+ 404: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ };
+ };
+ /**
+ * Bulk get workflows
+ * @description Returns a list of workflows and related statuses by providing workflow names, workflow IDs, or project and issue types.
+ *
+ * **[Permissions](#permissions) required:**
+ *
+ * * *Administer Jira* global permission to access all, including project-scoped, workflows
+ * * At least one of the *Administer projects* and *View (read-only) workflow* project permissions to access project-scoped workflows
+ */
+ readWorkflows: {
+ parameters: {
+ query?: {
+ /**
+ * @description Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:
+ *
+ * * `workflows.usages` Returns the project and issue types that each workflow is associated with.
+ * * `statuses.usages` Returns the project and issue types that each status is associated with.
+ */
+ expand?: string;
+ };
+ };
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "projectAndIssueTypes": [],
+ * "workflowIds": [],
+ * "workflowNames": [
+ * "Workflow 1",
+ * "Workflow 2"
+ * ]
+ * }
+ */
+ "application/json": components["schemas"]["WorkflowReadRequest"];
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["WorkflowReadResponse"];
+ };
+ };
+ /** @description Returned if the request is not valid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. */
+ 401: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get available workflow capabilities
+ * @description Get the list of workflow capabilities for a specific workflow using either the workflow ID, or the project and issue type ID pair. The response includes the scope of the workflow, defined as global/project-based, and a list of project types that the workflow is scoped to. It also includes all rules organised into their broad categories (conditions, validators, actions, triggers, screens) as well as the source location (Atlassian-provided, Connect, Forge).
+ *
+ * **[Permissions](#permissions) required:**
+ *
+ * * *Administer Jira* project permission to access all, including global-scoped, workflows
+ * * *Administer projects* project permissions to access project-scoped workflows
+ *
+ * The current list of Atlassian-provided rules:
+ *
+ * #### Validators ####
+ *
+ * A validator rule that checks if a user has the required permissions to execute the transition in the workflow.
+ *
+ * ##### Permission validator #####
+ *
+ * A validator rule that checks if a user has the required permissions to execute the transition in the workflow.
+ *
+ * {
+ * "ruleKey": "system:check-permission-validator",
+ * "parameters": {
+ * "permissionKey": "ADMINISTER_PROJECTS"
+ * }
+ * }
+ *
+ * Parameters:
+ *
+ * * `permissionKey` The permission required to perform the transition. Allowed values: [built-in Jira permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permission-schemes/#built-in-permissions).
+ *
+ * ##### Parent or child blocking validator #####
+ *
+ * A validator to block the child issue\\u2019s transition depending on the parent issue\\u2019s status.
+ *
+ * {
+ * "ruleKey" : "system:parent-or-child-blocking-validator"
+ * "parameters" : {
+ * "blocker" : "PARENT"
+ * "statusIds" : "1,2,3"
+ * }
+ * }
+ *
+ * Parameters:
+ *
+ * * `blocker` currently only supports `PARENT`.
+ * * `statusIds` a comma-separated list of status IDs.
+ *
+ * ##### Previous status validator #####
+ *
+ * A validator that checks if an issue has transitioned through specified previous status(es) before allowing the current transition to occur.
+ *
+ * {
+ * "ruleKey": "system:previous-status-validator",
+ * "parameters": {
+ * "previousStatusIds": "10014",
+ * "mostRecentStatusOnly": "true"
+ * }
+ * }
+ *
+ * Parameters:
+ *
+ * * `previousStatusIds` a comma-separated list of status IDs, currently only support one ID.
+ * * `mostRecentStatusOnly` when `true` only considers the most recent status for the condition evaluation. Allowed values: `true`, `false`.
+ *
+ * ##### Validate a field value #####
+ *
+ * A validation that ensures a specific field's value meets the defined criteria before allowing an issue to transition in the workflow.
+ *
+ * Depending on the rule type, the result will vary:
+ *
+ * ###### Field required ######
+ *
+ * {
+ * "ruleKey": "system:validate-field-value",
+ * "parameters": {
+ * "ruleType": "fieldRequired",
+ * "fieldsRequired": "assignee",
+ * "ignoreContext": "true",
+ * "errorMessage": "An assignee must be set!"
+ * }
+ * }
+ *
+ * Parameters:
+ *
+ * * `fieldsRequired` the ID of the field that is required. For a custom field, it would look like `customfield_123`.
+ * * `ignoreContext` controls the impact of context settings on field validation. When set to `true`, the validator doesn't check a required field if its context isn't configured for the current issue. When set to `false`, the validator requires a field even if its context is invalid. Allowed values: `true`, `false`.
+ * * `errorMessage` is the error message to display if the user does not provide a value during the transition. A default error message will be shown if you don't provide one (Optional).
+ *
+ * ###### Field changed ######
+ *
+ * {
+ * "ruleKey": "system:validate-field-value",
+ * "parameters": {
+ * "ruleType": "fieldChanged",
+ * "groupsExemptFromValidation": "6862ac20-8672-4f68-896d-4854f5efb79e",
+ * "fieldKey": "versions",
+ * "errorMessage": "Affect versions must be modified before transition"
+ * }
+ * }
+ *
+ * Parameters:
+ *
+ * * `groupsExemptFromValidation` a comma-separated list of group IDs to be exempt from the validation.
+ * * `fieldKey` the ID of the field that has changed. For a custom field, it would look like `customfield_123`.
+ * * `errorMessage` the error message to display if the user does not provide a value during the transition. A default error message will be shown if you don't provide one (Optional).
+ *
+ * ###### Field has a single value ######
+ *
+ * {
+ * "ruleKey": "system:validate-field-value",
+ * "parameters": {
+ * "ruleType": "fieldHasSingleValue",
+ * "fieldKey": "created",
+ * "excludeSubtasks": "true"
+ * }
+ * }
+ *
+ * Parameters:
+ *
+ * * `fieldKey` the ID of the field to validate. For a custom field, it would look like `customfield_123`.
+ * * `excludeSubtasks` Option to exclude values copied from sub-tasks. Allowed values: `true`, `false`.
+ *
+ * ###### Field matches regular expression ######
+ *
+ * {
+ * "ruleKey": "system:validate-field-value",
+ * "parameters": {
+ * "ruleType": "fieldMatchesRegularExpression",
+ * "regexp": "[0-9]{4}",
+ * "fieldKey": "description"
+ * }
+ * }
+ *
+ * Parameters:
+ *
+ * * `regexp` the regular expression used to validate the field\\u2019s content.
+ * * `fieldKey` the ID of the field to validate. For a custom field, it would look like `customfield_123`.
+ *
+ * ###### Date field comparison ######
+ *
+ * {
+ * "ruleKey": "system:validate-field-value",
+ * "parameters": {
+ * "ruleType": "dateFieldComparison",
+ * "date1FieldKey": "duedate",
+ * "date2FieldKey": "customfield_10054",
+ * "includeTime": "true",
+ * "conditionSelected": ">="
+ * }
+ * }
+ *
+ * Parameters:
+ *
+ * * `date1FieldKey` the ID of the first field to compare. For a custom field, it would look like `customfield_123`.
+ * * `date2FieldKey` the ID of the second field to compare. For a custom field, it would look like `customfield_123`.
+ * * `includeTime` if `true`, compares both date and time. Allowed values: `true`, `false`.
+ * * `conditionSelected` the condition to compare with. Allowed values: `>`, `>=`, `=`, `<=`, `<`, `!=`.
+ *
+ * ###### Date range comparison ######
+ *
+ * {
+ * "ruleKey": "system:validate-field-value",
+ * "parameters": {
+ * "ruleType": "windowDateComparison",
+ * "date1FieldKey": "customfield_10009",
+ * "date2FieldKey": "customfield_10054",
+ * "numberOfDays": "3"
+ * }
+ * }
+ *
+ * Parameters:
+ *
+ * * `date1FieldKey` the ID of the first field to compare. For a custom field, it would look like `customfield_123`.
+ * * `date2FieldKey` the ID of the second field to compare. For a custom field, it would look like `customfield_123`.
+ * * `numberOfDays` maximum number of days past the reference date (`date2FieldKey`) to pass validation.
+ *
+ * This rule is composed by aggregating the following legacy rules:
+ *
+ * * FieldRequiredValidator
+ * * FieldChangedValidator
+ * * FieldHasSingleValueValidator
+ * * RegexpFieldValidator
+ * * DateFieldValidator
+ * * WindowsDateValidator
+ *
+ * ##### Proforma: Forms attached validator #####
+ *
+ * Validates that one or more forms are attached to the issue.
+ *
+ * {
+ * "ruleKey" : "system:proforma-forms-attached"
+ * "parameters" : {}
+ * }
+ *
+ * ##### Proforma: Forms submitted validator #####
+ *
+ * Validates that all forms attached to the issue have been submitted.
+ *
+ * {
+ * "ruleKey" : "system:proforma-forms-submitted"
+ * "parameters" : {}
+ * }
+ *
+ * #### Conditions ####
+ *
+ * Conditions enable workflow rules that govern whether a transition can execute.
+ *
+ * ##### Check field value #####
+ *
+ * A condition rule evaluates as true if a specific field's value meets the defined criteria. This rule ensures that an issue can only transition to the next step in the workflow if the field's value matches the desired condition.
+ *
+ * {
+ * "ruleKey": "system:check-field-value",
+ * "parameters": {
+ * "fieldId": "description",
+ * "fieldValue": "[\"Done\"]",
+ * "comparator": "=",
+ * "comparisonType": "STRING"
+ * }
+ * }
+ *
+ * Parameters:
+ *
+ * * `fieldId` The ID of the field to check the value of. For non-system fields, it will look like `customfield_123`. Note: `fieldId` is used interchangeably with the idea of `fieldKey` here, they refer to the same field.
+ * * `fieldValue` the list of values to check against the field\\u2019s value.
+ * * `comparator` The comparison logic. Allowed values: `>`, `>=`, `=`, `<=`, `<`, `!=`.
+ * * `comparisonType` The type of data being compared. Allowed values: `STRING`, `NUMBER`, `DATE`, `DATE_WITHOUT_TIME`, `OPTIONID`.
+ *
+ * ##### Restrict issue transition #####
+ *
+ * This rule ensures that issue transitions are restricted based on user accounts, roles, group memberships, and permissions, maintaining control over who can transition an issue. This condition evaluates as `true` if any of the following criteria is met.
+ *
+ * {
+ * "ruleKey": "system:restrict-issue-transition",
+ * "parameters": {
+ * "accountIds": "allow-reporter,5e68ac137d64450d01a77fa0",
+ * "roleIds": "10002,10004",
+ * "groupIds": "703ff44a-7dc8-4f4b-9aa6-a65bf3574fa4",
+ * "permissionKeys": "ADMINISTER_PROJECTS",
+ * "groupCustomFields": "customfield_10028",
+ * "allowUserCustomFields": "customfield_10072,customfield_10144,customfield_10007",
+ * "denyUserCustomFields": "customfield_10107"
+ * }
+ * }
+ *
+ * Parameters:
+ *
+ * * `accountIds` a comma-separated list of the user account IDs. It also allows generic values like: `allow-assignee`, `allow-reporter`, and `accountIds` Note: This is only supported in team-managed projects
+ * * `roleIds` a comma-separated list of role IDs.
+ * * `groupIds` a comma-separated list of group IDs.
+ * * `permissionKeys` a comma-separated list of permission keys. Allowed values: [built-in Jira permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permission-schemes/#built-in-permissions).
+ * * `groupCustomFields` a comma-separated list of group custom field IDs.
+ * * `allowUserCustomFields` a comma-separated list of user custom field IDs to allow for issue transition.
+ * * `denyUserCustomFields` a comma-separated list of user custom field IDs to deny for issue transition.
+ *
+ * This rule is composed by aggregating the following legacy rules:
+ *
+ * * AllowOnlyAssignee
+ * * AllowOnlyReporter
+ * * InAnyProjectRoleCondition
+ * * InProjectRoleCondition
+ * * UserInAnyGroupCondition
+ * * UserInGroupCondition
+ * * PermissionCondtion
+ * * InGroupCFCondition
+ * * UserIsInCustomFieldCondition
+ *
+ * ##### Previous status condition #####
+ *
+ * A condition that evaluates based on an issue's previous status(es) and specific criteria.
+ *
+ * {
+ * "ruleKey" : "system:previous-status-condition"
+ * "parameters" : {
+ * "previousStatusIds" : "10004",
+ * "not": "true",
+ * "mostRecentStatusOnly" : "true",
+ * "includeCurrentStatus": "true",
+ * "ignoreLoopTransitions": "true"
+ * }
+ * }
+ *
+ * Parameters:
+ *
+ * * `previousStatusIds` a comma-separated list of status IDs, current only support one ID.
+ * * `not` indicates if the condition should be reversed. When `true` it checks that the issue has not been in the selected statuses. Allowed values: `true`, `false`.
+ * * `mostRecentStatusOnly` when true only considers the most recent status for the condition evaluation. Allowed values: `true`, `false`.
+ * * `includeCurrentStatus` includes the current status when evaluating if the issue has been through the selected statuses. Allowed values: `true`, `false`.
+ * * `ignoreLoopTransitions` ignore loop transitions. Allowed values: `true`, `false`.
+ *
+ * ##### Parent or child blocking condition #####
+ *
+ * A condition to block the parent\\u2019s issue transition depending on the child\\u2019s issue status.
+ *
+ * {
+ * "ruleKey" : "system:parent-or-child-blocking-condition"
+ * "parameters" : {
+ * "blocker" : "CHILD",
+ * "statusIds" : "1,2,3"
+ * }
+ * }
+ *
+ * Parameters:
+ *
+ * * `blocker` currently only supports `CHILD`.
+ * * `statusIds` a comma-separated list of status IDs.
+ *
+ * ##### Separation of duties #####
+ *
+ * A condition preventing the user from performing, if the user has already performed a transition on the issue.
+ *
+ * {
+ * "ruleKey": "system:separation-of-duties",
+ * "parameters": {
+ * "fromStatusId": "10161",
+ * "toStatusId": "10160"
+ * }
+ * }
+ *
+ * Parameters:
+ *
+ * * `fromStatusId` represents the status ID from which the issue is transitioning. It ensures that the user performing the current transition has not performed any actions when the issue was in the specified status.
+ * * `toStatusId` represents the status ID to which the issue is transitioning. It ensures that the user performing the current transition is not the same user who has previously transitioned the issue.
+ *
+ * ##### Restrict transitions #####
+ *
+ * A condition preventing all users from transitioning the issue can also optionally include APIs as well.
+ *
+ * {
+ * "ruleKey": "system:restrict-from-all-users",
+ * "parameters": {
+ * "restrictMode": "users"
+ * }
+ * }
+ *
+ * Parameters:
+ *
+ * * `restrictMode` restricts the issue transition including/excluding APIs. Allowed values: `"users"`, `"usersAndAPI"`.
+ *
+ * ##### Jira Service Management block until approved #####
+ *
+ * Block an issue transition until approval. Note: This is only supported in team-managed projects.
+ *
+ * {
+ * "ruleKey": "system:jsd-approvals-block-until-approved",
+ * "parameters": {
+ * "approvalConfigurationJson": "{"statusExternalUuid...}"
+ * }
+ * }
+ *
+ * Parameters:
+ *
+ * * `approvalConfigurationJson` a stringified JSON holding the Jira Service Management approval configuration.
+ *
+ * ##### Jira Service Management block until rejected #####
+ *
+ * Block an issue transition until rejected. Note: This is only supported in team-managed projects.
+ *
+ * {
+ * "ruleKey": "system:jsd-approvals-block-until-rejected",
+ * "parameters": {
+ * "approvalConfigurationJson": "{"statusExternalUuid...}"
+ * }
+ * }
+ *
+ * Parameters:
+ *
+ * * `approvalConfigurationJson` a stringified JSON holding the Jira Service Management approval configuration.
+ *
+ * ##### Block in progress approval #####
+ *
+ * Condition to block issue transition if there is pending approval. Note: This is only supported in company-managed projects.
+ *
+ * {
+ * "ruleKey": "system:block-in-progress-approval",
+ * "parameters": {}
+ * }
+ *
+ * #### Post functions ####
+ *
+ * Post functions carry out any additional processing required after a workflow transition is executed.
+ *
+ * ##### Change assignee #####
+ *
+ * A post function rule that changes the assignee of an issue after a transition.
+ *
+ * {
+ * "ruleKey": "system:change-assignee",
+ * "parameters": {
+ * "type": "to-selected-user",
+ * "accountId": "example-account-id"
+ * }
+ * }
+ *
+ * Parameters:
+ *
+ * * `type` the parameter used to determine the new assignee. Allowed values: `to-selected-user`, `to-unassigned`, `to-current-user`, `to-current-user`, `to-default-user`, `to-default-user`
+ * * `accountId` the account ID of the user to assign the issue to. This parameter is required only when the type is `"to-selected-user"`.
+ *
+ * ##### Copy field value #####
+ *
+ * A post function that automates the process of copying values between fields during a specific transition, ensuring data consistency and reducing manual effort.
+ *
+ * {
+ * "ruleKey": "system:copy-value-from-other-field",
+ * "parameters": {
+ * "sourceFieldKey": "description",
+ * "targetFieldKey": "components",
+ * "issueSource": "SAME"
+ * }
+ * }
+ *
+ * Parameters:
+ *
+ * * `sourceFieldKey` the field key to copy from. For a custom field, it would look like `customfield_123`
+ * * `targetFieldKey` the field key to copy to. For a custom field, it would look like `customfield_123`
+ * * `issueSource` `SAME` or `PARENT`. Defaults to `SAME` if no value is provided.
+ *
+ * ##### Update field #####
+ *
+ * A post function that updates or appends a specific field with the given value.
+ *
+ * {
+ * "ruleKey": "system:update-field",
+ * "parameters": {
+ * "field": "customfield_10056",
+ * "value": "asdf",
+ * "mode": "append"
+ * }
+ * }
+ *
+ * Parameters:
+ *
+ * * `field` the ID of the field to update. For a custom field, it would look like `customfield_123`
+ * * `value` the value to update the field with.
+ * * `mode` `append` or `replace`. Determines if a value will be appended to the current value, or if the current value will be replaced.
+ *
+ * ##### Trigger webhook #####
+ *
+ * A post function that automatically triggers a predefined webhook when a transition occurs in the workflow.
+ *
+ * {
+ * "ruleKey": "system:trigger-webhook",
+ * "parameters": {
+ * "webhookId": "1"
+ * }
+ * }
+ *
+ * Parameters:
+ *
+ * * `webhookId` the ID of the webhook.
+ *
+ * #### Screen ####
+ *
+ * ##### Remind people to update fields #####
+ *
+ * A screen rule that prompts users to update a specific field when they interact with an issue screen during a transition. This rule is useful for ensuring that users provide or modify necessary information before moving an issue to the next step in the workflow.
+ *
+ * {
+ * "ruleKey": "system:remind-people-to-update-fields",
+ * "params": {
+ * "remindingFieldIds": "assignee,customfield_10025",
+ * "remindingMessage": "The message",
+ * "remindingAlwaysAsk": "true"
+ * }
+ * }
+ *
+ * Parameters:
+ *
+ * * `remindingFieldIds` a comma-separated list of field IDs. Note: `fieldId` is used interchangeably with the idea of `fieldKey` here, they refer to the same field.
+ * * `remindingMessage` the message to display when prompting the users to update the fields.
+ * * `remindingAlwaysAsk` always remind to update fields. Allowed values: `true`, `false`.
+ *
+ * ##### Shared transition screen #####
+ *
+ * A common screen that is shared between transitions in a workflow.
+ *
+ * {
+ * "ruleKey": "system:transition-screen",
+ * "params": {
+ * "screenId": "3"
+ * }
+ * }
+ *
+ * Parameters:
+ *
+ * * `screenId` the ID of the screen.
+ *
+ * #### Connect & Forge ####
+ *
+ * ##### Connect rules #####
+ *
+ * Validator/Condition/Post function for Connect app.
+ *
+ * {
+ * "ruleKey": "connect:expression-validator",
+ * "parameters": {
+ * "appKey": "com.atlassian.app",
+ * "config": "",
+ * "id": "90ce590f-e90c-4cd3-8281-165ce41f2ac3",
+ * "disabled": "false",
+ * "tag": ""
+ * }
+ * }
+ *
+ * Parameters:
+ *
+ * * `ruleKey` Validator: `connect:expression-validator`, Condition: `connect:expression-condition`, and Post function: `connect:remote-workflow-function`
+ * * `appKey` the reference to the Connect app
+ * * `config` a JSON payload string describing the configuration
+ * * `id` the ID of the rule
+ * * `disabled` determine if the Connect app is disabled. Allowed values: `true`, `false`.
+ * * `tag` additional tags for the Connect app
+ *
+ * ##### Forge rules #####
+ *
+ * Validator/Condition/Post function for Forge app.
+ *
+ * {
+ * "ruleKey": "forge:expression-validator",
+ * "parameters": {
+ * "key": "ari:cloud:ecosystem::extension/{appId}/{environmentId}/static/{moduleKey}",
+ * "config": "{"searchString":"workflow validator"}",
+ * "id": "a865ddf6-bb3f-4a7b-9540-c2f8b3f9f6c2"
+ * }
+ * }
+ *
+ * Parameters:
+ *
+ * * `ruleKey` Validator: `forge:expression-validator`, Condition: `forge:expression-condition`, and Post function: `forge:workflow-post-function`
+ * * `key` the identifier for the Forge app
+ * * `config` the persistent stringified JSON configuration for the Forge rule
+ * * `id` the ID of the Forge rule
+ */
+ workflowCapabilities: {
+ parameters: {
+ query?: {
+ workflowId?: string;
+ projectId?: string;
+ issueTypeId?: string;
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["WorkflowCapabilities"];
+ };
+ };
+ /** @description Returned if the request is not valid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. */
+ 401: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Bulk create workflows
+ * @description Create workflows and related statuses.
+ *
+ * **[Permissions](#permissions) required:**
+ *
+ * * *Administer Jira* project permission to create all, including global-scoped, workflows
+ * * *Administer projects* project permissions to create project-scoped workflows
+ */
+ createWorkflows: {
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "scope": {
+ * "type": "GLOBAL"
+ * },
+ * "statuses": [
+ * {
+ * "description": "",
+ * "name": "To Do",
+ * "statusCategory": "TODO",
+ * "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
+ * },
+ * {
+ * "description": "",
+ * "name": "In Progress",
+ * "statusCategory": "IN_PROGRESS",
+ * "statusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8"
+ * },
+ * {
+ * "description": "",
+ * "name": "Done",
+ * "statusCategory": "DONE",
+ * "statusReference": "6b3fc04d-3316-46c5-a257-65751aeb8849"
+ * }
+ * ],
+ * "workflows": [
+ * {
+ * "description": "",
+ * "name": "Software workflow 1",
+ * "startPointLayout": {
+ * "x": -100.00030899047852,
+ * "y": -153.00020599365234
+ * },
+ * "statuses": [
+ * {
+ * "layout": {
+ * "x": 114.99993896484375,
+ * "y": -16
+ * },
+ * "properties": {},
+ * "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
+ * },
+ * {
+ * "layout": {
+ * "x": 317.0000915527344,
+ * "y": -16
+ * },
+ * "properties": {},
+ * "statusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8"
+ * },
+ * {
+ * "layout": {
+ * "x": 508.000244140625,
+ * "y": -16
+ * },
+ * "properties": {},
+ * "statusReference": "6b3fc04d-3316-46c5-a257-65751aeb8849"
+ * }
+ * ],
+ * "transitions": [
+ * {
+ * "actions": [],
+ * "description": "",
+ * "from": [],
+ * "id": "1",
+ * "name": "Create",
+ * "properties": {},
+ * "to": {
+ * "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
+ * },
+ * "triggers": [],
+ * "type": "INITIAL",
+ * "validators": []
+ * },
+ * {
+ * "actions": [],
+ * "description": "",
+ * "from": [],
+ * "id": "11",
+ * "name": "To Do",
+ * "properties": {},
+ * "to": {
+ * "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
+ * },
+ * "triggers": [],
+ * "type": "GLOBAL",
+ * "validators": []
+ * },
+ * {
+ * "actions": [],
+ * "description": "",
+ * "from": [],
+ * "id": "21",
+ * "name": "In Progress",
+ * "properties": {},
+ * "to": {
+ * "statusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8"
+ * },
+ * "triggers": [],
+ * "type": "GLOBAL",
+ * "validators": []
+ * },
+ * {
+ * "actions": [],
+ * "description": "",
+ * "from": [],
+ * "id": "31",
+ * "name": "Done",
+ * "properties": {},
+ * "to": {
+ * "statusReference": "6b3fc04d-3316-46c5-a257-65751aeb8849"
+ * },
+ * "triggers": [],
+ * "type": "GLOBAL",
+ * "validators": []
+ * }
+ * ]
+ * }
+ * ]
+ * }
+ */
+ "application/json": components["schemas"]["WorkflowCreateRequest"];
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["WorkflowCreateResponse"];
+ };
+ };
+ /** @description Returned if the request is not valid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. */
+ 401: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Validate create workflows
+ * @description Validate the payload for bulk create workflows.
+ *
+ * **[Permissions](#permissions) required:**
+ *
+ * * *Administer Jira* project permission to create all, including global-scoped, workflows
+ * * *Administer projects* project permissions to create project-scoped workflows
+ */
+ validateCreateWorkflows: {
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "payload": {
+ * "scope": {
+ * "type": "GLOBAL"
+ * },
+ * "statuses": [
+ * {
+ * "description": "",
+ * "name": "To Do",
+ * "statusCategory": "TODO",
+ * "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
+ * },
+ * {
+ * "description": "",
+ * "name": "In Progress",
+ * "statusCategory": "IN_PROGRESS",
+ * "statusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8"
+ * },
+ * {
+ * "description": "",
+ * "name": "Done",
+ * "statusCategory": "DONE",
+ * "statusReference": "6b3fc04d-3316-46c5-a257-65751aeb8849"
+ * }
+ * ],
+ * "workflows": [
+ * {
+ * "description": "",
+ * "name": "Software workflow 1",
+ * "startPointLayout": {
+ * "x": -100.00030899047852,
+ * "y": -153.00020599365234
+ * },
+ * "statuses": [
+ * {
+ * "layout": {
+ * "x": 114.99993896484375,
+ * "y": -16
+ * },
+ * "properties": {},
+ * "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
+ * },
+ * {
+ * "layout": {
+ * "x": 317.0000915527344,
+ * "y": -16
+ * },
+ * "properties": {},
+ * "statusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8"
+ * },
+ * {
+ * "layout": {
+ * "x": 508.000244140625,
+ * "y": -16
+ * },
+ * "properties": {},
+ * "statusReference": "6b3fc04d-3316-46c5-a257-65751aeb8849"
+ * }
+ * ],
+ * "transitions": [
+ * {
+ * "actions": [],
+ * "description": "",
+ * "from": [],
+ * "id": "1",
+ * "name": "Create",
+ * "properties": {},
+ * "to": {
+ * "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
+ * },
+ * "triggers": [],
+ * "type": "INITIAL",
+ * "validators": []
+ * },
+ * {
+ * "actions": [],
+ * "description": "",
+ * "from": [],
+ * "id": "11",
+ * "name": "To Do",
+ * "properties": {},
+ * "to": {
+ * "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
+ * },
+ * "triggers": [],
+ * "type": "GLOBAL",
+ * "validators": []
+ * },
+ * {
+ * "actions": [],
+ * "description": "",
+ * "from": [],
+ * "id": "21",
+ * "name": "In Progress",
+ * "properties": {},
+ * "to": {
+ * "statusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8"
+ * },
+ * "triggers": [],
+ * "type": "GLOBAL",
+ * "validators": []
+ * },
+ * {
+ * "actions": [],
+ * "description": "",
+ * "from": [],
+ * "id": "31",
+ * "name": "Done",
+ * "properties": {},
+ * "to": {
+ * "statusReference": "6b3fc04d-3316-46c5-a257-65751aeb8849"
+ * },
+ * "triggers": [],
+ * "type": "GLOBAL",
+ * "validators": []
+ * }
+ * ]
+ * }
+ * ]
+ * },
+ * "validationOptions": {
+ * "levels": [
+ * "ERROR",
+ * "WARNING"
+ * ]
+ * }
+ * }
+ */
+ "application/json": components["schemas"]["WorkflowCreateValidateRequest"];
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["WorkflowValidationErrorList"];
+ };
+ };
+ /** @description Returned if the request is not valid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. */
+ 401: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Bulk update workflows
+ * @description Update workflows and related statuses.
+ *
+ * **[Permissions](#permissions) required:**
+ *
+ * * *Administer Jira* project permission to create all, including global-scoped, workflows
+ * * *Administer projects* project permissions to create project-scoped workflows
+ */
+ updateWorkflows: {
+ parameters: {
+ query?: {
+ /**
+ * @description Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:
+ *
+ * * `workflows.usages` Returns the project and issue types that each workflow is associated with.
+ * * `statuses.usages` Returns the project and issue types that each status is associated with.
+ */
+ expand?: string;
+ };
+ };
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "statuses": [
+ * {
+ * "description": "",
+ * "name": "To Do",
+ * "statusCategory": "TODO",
+ * "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
+ * },
+ * {
+ * "description": "",
+ * "name": "In Progress",
+ * "statusCategory": "IN_PROGRESS",
+ * "statusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8"
+ * },
+ * {
+ * "description": "",
+ * "name": "Done",
+ * "statusCategory": "DONE",
+ * "statusReference": "6b3fc04d-3316-46c5-a257-65751aeb8849"
+ * }
+ * ],
+ * "workflows": [
+ * {
+ * "defaultStatusMappings": [
+ * {
+ * "newStatusReference": "10011",
+ * "oldStatusReference": "10010"
+ * }
+ * ],
+ * "description": "",
+ * "id": "10001",
+ * "startPointLayout": {
+ * "x": -100.00030899047852,
+ * "y": -153.00020599365234
+ * },
+ * "statusMappings": [
+ * {
+ * "issueTypeId": "10002",
+ * "projectId": "10003",
+ * "statusMigrations": [
+ * {
+ * "newStatusReference": "10011",
+ * "oldStatusReference": "10010"
+ * }
+ * ]
+ * }
+ * ],
+ * "statuses": [
+ * {
+ * "layout": {
+ * "x": 114.99993896484375,
+ * "y": -16
+ * },
+ * "properties": {},
+ * "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
+ * },
+ * {
+ * "layout": {
+ * "x": 317.0000915527344,
+ * "y": -16
+ * },
+ * "properties": {},
+ * "statusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8"
+ * },
+ * {
+ * "layout": {
+ * "x": 508.000244140625,
+ * "y": -16
+ * },
+ * "properties": {},
+ * "statusReference": "6b3fc04d-3316-46c5-a257-65751aeb8849"
+ * }
+ * ],
+ * "transitions": [
+ * {
+ * "actions": [],
+ * "description": "",
+ * "from": [],
+ * "id": "1",
+ * "name": "Create",
+ * "properties": {},
+ * "to": {
+ * "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
+ * },
+ * "triggers": [],
+ * "type": "INITIAL",
+ * "validators": []
+ * },
+ * {
+ * "actions": [],
+ * "description": "",
+ * "from": [],
+ * "id": "11",
+ * "name": "To Do",
+ * "properties": {},
+ * "to": {
+ * "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
+ * },
+ * "triggers": [],
+ * "type": "GLOBAL",
+ * "validators": []
+ * },
+ * {
+ * "actions": [],
+ * "description": "",
+ * "from": [],
+ * "id": "21",
+ * "name": "In Progress",
+ * "properties": {},
+ * "to": {
+ * "statusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8"
+ * },
+ * "triggers": [],
+ * "type": "GLOBAL",
+ * "validators": []
+ * },
+ * {
+ * "actions": [],
+ * "description": "",
+ * "from": [],
+ * "id": "31",
+ * "name": "Done",
+ * "properties": {},
+ * "to": {
+ * "statusReference": "6b3fc04d-3316-46c5-a257-65751aeb8849"
+ * },
+ * "triggers": [],
+ * "type": "GLOBAL",
+ * "validators": []
+ * }
+ * ],
+ * "version": {
+ * "id": "6f6c988b-2590-4358-90c2-5f7960265592",
+ * "versionNumber": 1
+ * }
+ * }
+ * ]
+ * }
+ */
+ "application/json": components["schemas"]["WorkflowUpdateRequest"];
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["WorkflowUpdateResponse"];
+ };
+ };
+ /** @description Returned if the request is not valid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. */
+ 401: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Validate update workflows
+ * @description Validate the payload for bulk update workflows.
+ *
+ * **[Permissions](#permissions) required:**
+ *
+ * * *Administer Jira* project permission to create all, including global-scoped, workflows
+ * * *Administer projects* project permissions to create project-scoped workflows
+ */
+ validateUpdateWorkflows: {
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "payload": {
+ * "statuses": [
+ * {
+ * "description": "",
+ * "name": "To Do",
+ * "statusCategory": "TODO",
+ * "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
+ * },
+ * {
+ * "description": "",
+ * "name": "In Progress",
+ * "statusCategory": "IN_PROGRESS",
+ * "statusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8"
+ * },
+ * {
+ * "description": "",
+ * "name": "Done",
+ * "statusCategory": "DONE",
+ * "statusReference": "6b3fc04d-3316-46c5-a257-65751aeb8849"
+ * }
+ * ],
+ * "workflows": [
+ * {
+ * "defaultStatusMappings": [
+ * {
+ * "newStatusReference": "10011",
+ * "oldStatusReference": "10010"
+ * }
+ * ],
+ * "description": "",
+ * "id": "10001",
+ * "startPointLayout": {
+ * "x": -100.00030899047852,
+ * "y": -153.00020599365234
+ * },
+ * "statusMappings": [
+ * {
+ * "issueTypeId": "10002",
+ * "projectId": "10003",
+ * "statusMigrations": [
+ * {
+ * "newStatusReference": "10011",
+ * "oldStatusReference": "10010"
+ * }
+ * ]
+ * }
+ * ],
+ * "statuses": [
+ * {
+ * "layout": {
+ * "x": 114.99993896484375,
+ * "y": -16
+ * },
+ * "properties": {},
+ * "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
+ * },
+ * {
+ * "layout": {
+ * "x": 317.0000915527344,
+ * "y": -16
+ * },
+ * "properties": {},
+ * "statusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8"
+ * },
+ * {
+ * "layout": {
+ * "x": 508.000244140625,
+ * "y": -16
+ * },
+ * "properties": {},
+ * "statusReference": "6b3fc04d-3316-46c5-a257-65751aeb8849"
+ * }
+ * ],
+ * "transitions": [
+ * {
+ * "actions": [],
+ * "description": "",
+ * "from": [],
+ * "id": "1",
+ * "name": "Create",
+ * "properties": {},
+ * "to": {
+ * "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
+ * },
+ * "triggers": [],
+ * "type": "INITIAL",
+ * "validators": []
+ * },
+ * {
+ * "actions": [],
+ * "description": "",
+ * "from": [],
+ * "id": "11",
+ * "name": "To Do",
+ * "properties": {},
+ * "to": {
+ * "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
+ * },
+ * "triggers": [],
+ * "type": "GLOBAL",
+ * "validators": []
+ * },
+ * {
+ * "actions": [],
+ * "description": "",
+ * "from": [],
+ * "id": "21",
+ * "name": "In Progress",
+ * "properties": {},
+ * "to": {
+ * "statusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8"
+ * },
+ * "triggers": [],
+ * "type": "GLOBAL",
+ * "validators": []
+ * },
+ * {
+ * "actions": [],
+ * "description": "",
+ * "from": [],
+ * "id": "31",
+ * "name": "Done",
+ * "properties": {},
+ * "to": {
+ * "statusReference": "6b3fc04d-3316-46c5-a257-65751aeb8849"
+ * },
+ * "triggers": [],
+ * "type": "GLOBAL",
+ * "validators": []
+ * }
+ * ],
+ * "version": {
+ * "id": "6f6c988b-2590-4358-90c2-5f7960265592",
+ * "versionNumber": 1
+ * }
+ * }
+ * ]
+ * },
+ * "validationOptions": {
+ * "levels": [
+ * "ERROR",
+ * "WARNING"
+ * ]
+ * }
+ * }
+ */
+ "application/json": components["schemas"]["WorkflowUpdateValidateRequestBean"];
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["WorkflowValidationErrorList"];
+ };
+ };
+ /** @description Returned if the request is not valid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. */
+ 401: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get all workflow schemes
+ * @description Returns a [paginated](#pagination) list of all workflow schemes, not including draft workflow schemes.
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ getAllWorkflowSchemes: {
+ parameters: {
+ query?: {
+ /** @description The index of the first item to return in a page of results (page offset). */
+ startAt?: number;
+ /** @description The maximum number of items to return per page. */
+ maxResults?: number;
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["PageBeanWorkflowScheme"];
+ };
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the necessary permission. */
+ 403: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Create workflow scheme
+ * @description Creates a workflow scheme.
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ createWorkflowScheme: {
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "defaultWorkflow": "jira",
+ * "description": "The description of the example workflow scheme.",
+ * "issueTypeMappings": {
+ * "10000": "scrum workflow",
+ * "10001": "builds workflow"
+ * },
+ * "name": "Example workflow scheme"
+ * }
+ */
+ "application/json": components["schemas"]["WorkflowScheme"];
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["WorkflowScheme"];
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the necessary permission. */
+ 403: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get workflow scheme project associations
+ * @description Returns a list of the workflow schemes associated with a list of projects. Each returned workflow scheme includes a list of the requested projects associated with it. Any team-managed or non-existent projects in the request are ignored and no errors are returned.
+ *
+ * If the project is associated with the `Default Workflow Scheme` no ID is returned. This is because the way the `Default Workflow Scheme` is stored means it has no ID.
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ getWorkflowSchemeProjectAssociations: {
+ parameters: {
+ query: {
+ /** @description 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`. */
+ projectId: number[];
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["ContainerOfWorkflowSchemeAssociations"];
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the necessary permission. */
+ 403: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ };
+ };
+ /**
+ * Assign workflow scheme to project
+ * @description Assigns a workflow scheme to a project. This operation is performed only when there are no issues in the project.
+ *
+ * Workflow schemes can only be assigned to classic projects.
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ assignSchemeToProject: {
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "projectId": "10001",
+ * "workflowSchemeId": "10032"
+ * }
+ */
+ "application/json": components["schemas"]["WorkflowSchemeProjectAssociation"];
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 204: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the request is not valid. */
+ 400: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the required permissions. */
+ 403: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the workflow scheme or the project are not found. */
+ 404: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ };
+ };
+ /**
+ * Bulk get workflow schemes
+ * @description Returns a list of workflow schemes by providing workflow scheme IDs or project IDs.
+ *
+ * **[Permissions](#permissions) required:**
+ *
+ * * *Administer Jira* global permission to access all, including project-scoped, workflow schemes
+ * * *Administer projects* project permissions to access project-scoped workflow schemes
+ */
+ readWorkflowSchemes: {
+ parameters: {
+ query?: {
+ /**
+ * @description Use [expand](#expansion) to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:
+ *
+ * * `workflows.usages` Returns the project and issue types that each workflow in the workflow scheme is associated with.
+ */
+ expand?: string;
+ };
+ };
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "projectIds": [
+ * "10047",
+ * "10048"
+ * ],
+ * "workflowSchemeIds": [
+ * "3e59db0f-ed6c-47ce-8d50-80c0c4572677"
+ * ]
+ * }
+ */
+ "application/json": components["schemas"]["WorkflowSchemeReadRequest"];
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["WorkflowSchemeReadResponse"][];
+ };
+ };
+ /** @description Returned if the request is not valid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. */
+ 401: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Update workflow scheme
+ * @description Updates company-managed and team-managed project workflow schemes. This API doesn't have a concept of draft, so any changes made to a workflow scheme are immediately available. When changing the available statuses for issue types, an [asynchronous task](#async) migrates the issues as defined in the provided mappings.
+ *
+ * **[Permissions](#permissions) required:**
+ *
+ * * *Administer Jira* project permission to update all, including global-scoped, workflow schemes.
+ * * *Administer projects* project permission to update project-scoped workflow schemes.
+ */
+ updateSchemes: {
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "defaultWorkflowId": "3e59db0f-ed6c-47ce-8d50-80c0c4572677",
+ * "description": "description",
+ * "id": "10000",
+ * "name": "name",
+ * "statusMappingsByIssueTypeOverride": [
+ * {
+ * "issueTypeId": "10001",
+ * "statusMappings": [
+ * {
+ * "newStatusId": "2",
+ * "oldStatusId": "1"
+ * },
+ * {
+ * "newStatusId": "4",
+ * "oldStatusId": "3"
+ * }
+ * ]
+ * },
+ * {
+ * "issueTypeId": "10002",
+ * "statusMappings": [
+ * {
+ * "newStatusId": "4",
+ * "oldStatusId": "1"
+ * },
+ * {
+ * "newStatusId": "2",
+ * "oldStatusId": "3"
+ * }
+ * ]
+ * }
+ * ],
+ * "statusMappingsByWorkflows": [
+ * {
+ * "newWorkflowId": "3e59db0f-ed6c-47ce-8d50-80c0c4572677",
+ * "oldWorkflowId": "3e59db0f-ed6c-47ce-8d50-80c0c4572677",
+ * "statusMappings": [
+ * {
+ * "newStatusId": "2",
+ * "oldStatusId": "1"
+ * },
+ * {
+ * "newStatusId": "4",
+ * "oldStatusId": "3"
+ * }
+ * ]
+ * }
+ * ],
+ * "version": {
+ * "id": "527213fc-bc72-400f-aae0-df8d88db2c8a",
+ * "versionNumber": 1
+ * },
+ * "workflowsForIssueTypes": [
+ * {
+ * "issueTypeIds": [
+ * "10000",
+ * "10003"
+ * ],
+ * "workflowId": "3e59db0f-ed6c-47ce-8d50-80c0c4572677"
+ * },
+ * {
+ * "issueTypeIds": [
+ * "10001`",
+ * "10002"
+ * ],
+ * "workflowId": "3f83dg2a-ns2n-56ab-9812-42h5j1461629"
+ * }
+ * ]
+ * }
+ */
+ "application/json": components["schemas"]["WorkflowSchemeUpdateRequest"];
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful and there is no asynchronous task. */
+ 200: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the request is successful and there is an asynchronous task for the migrations. */
+ 303: {
+ content: {
+ "application/json": components["schemas"]["TaskProgressBeanObject"];
+ };
+ };
+ /** @description Returned if the request is not valid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. */
+ 401: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get required status mappings for workflow scheme update
+ * @description Gets the required status mappings for the desired changes to a workflow scheme. The results are provided per issue type and workflow. When updating a workflow scheme, status mappings can be provided per issue type, per workflow, or both.
+ *
+ * **[Permissions](#permissions) required:**
+ *
+ * * *Administer Jira* permission to update all, including global-scoped, workflow schemes.
+ * * *Administer projects* project permission to update project-scoped workflow schemes.
+ */
+ updateWorkflowSchemeMappings: {
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "defaultWorkflowId": "10010",
+ * "id": "10001",
+ * "workflowsForIssueTypes": [
+ * {
+ * "issueTypeIds": [
+ * "10010",
+ * "10011"
+ * ],
+ * "workflowId": "10001"
+ * }
+ * ]
+ * }
+ */
+ "application/json": components["schemas"]["WorkflowSchemeUpdateRequiredMappingsRequest"];
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["WorkflowSchemeUpdateRequiredMappingsResponse"];
+ };
+ };
+ /** @description Returned if the request is not valid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing, or the caller doesn't have permissions to perform the operation. */
+ 401: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get workflow scheme
+ * @description Returns a workflow scheme.
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ getWorkflowScheme: {
+ parameters: {
+ query?: {
+ /** @description 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. */
+ returnDraftIfExists?: boolean;
+ };
+ path: {
+ /** @description The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as `schemeId`. For example, *schemeId=10301*. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["WorkflowScheme"];
+ };
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the necessary permission. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the workflow scheme is not found. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Classic update workflow scheme
+ * @description Updates a company-manged project workflow scheme, including the name, default workflow, issue type to project mappings, and more. If the workflow scheme is active (that is, being used by at least one project), then a draft workflow scheme is created or updated instead, provided that `updateDraftIfNeeded` is set to `true`.
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ updateWorkflowScheme: {
+ parameters: {
+ path: {
+ /** @description The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as `schemeId`. For example, *schemeId=10301*. */
+ id: number;
+ };
+ };
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "defaultWorkflow": "jira",
+ * "description": "The description of the example workflow scheme.",
+ * "issueTypeMappings": {
+ * "10000": "scrum workflow"
+ * },
+ * "name": "Example workflow scheme",
+ * "updateDraftIfNeeded": false
+ * }
+ */
+ "application/json": components["schemas"]["WorkflowScheme"];
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["WorkflowScheme"];
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the necessary permission. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the workflow scheme is not found. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Delete workflow scheme
+ * @description Deletes a workflow scheme. Note that a workflow scheme cannot be deleted if it is active (that is, being used by at least one project).
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ deleteWorkflowScheme: {
+ parameters: {
+ path: {
+ /** @description The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as `schemeId`. For example, *schemeId=10301*. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 204: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the scheme is active. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the necessary permission. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the workflow scheme is not found. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Create draft workflow scheme
+ * @description Create a draft workflow scheme from an active workflow scheme, by copying the active workflow scheme. Note that an active workflow scheme can only have one draft workflow scheme.
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ createWorkflowSchemeDraftFromParent: {
+ parameters: {
+ path: {
+ /** @description The ID of the active workflow scheme that the draft is created from. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["WorkflowScheme"];
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the necessary permission. */
+ 403: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get default workflow
+ * @description Returns the default workflow for a workflow scheme. The default workflow is the workflow that is assigned any issue types that have not been mapped to any other workflow. The default workflow has *All Unassigned Issue Types* listed in its issue types for the workflow scheme in Jira.
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ getDefaultWorkflow: {
+ parameters: {
+ query?: {
+ /** @description Set to `true` to return the default workflow for the workflow scheme's draft rather than scheme itself. If the workflow scheme does not have a draft, then the default workflow for the workflow scheme is returned. */
+ returnDraftIfExists?: boolean;
+ };
+ path: {
+ /** @description The ID of the workflow scheme. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["DefaultWorkflow"];
+ };
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the necessary permission. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the workflow scheme is not found. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Update default workflow
+ * @description Sets the default workflow for a workflow scheme.
+ *
+ * Note that active workflow schemes cannot be edited. If the workflow scheme is active, set `updateDraftIfNeeded` to `true` in the request object and a draft workflow scheme is created or updated with the new default workflow. The draft workflow scheme can be published in Jira.
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ updateDefaultWorkflow: {
+ parameters: {
+ path: {
+ /** @description The ID of the workflow scheme. */
+ id: number;
+ };
+ };
+ /** @description The new default workflow. */
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "updateDraftIfNeeded": false,
+ * "workflow": "jira"
+ * }
+ */
+ "application/json": components["schemas"]["DefaultWorkflow"];
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["WorkflowScheme"];
+ };
+ };
+ /** @description Returned if the workflow scheme cannot be edited and `updateDraftIfNeeded` is not `true`. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the necessary permission. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the workflow scheme is not found. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Delete default workflow
+ * @description Resets the default workflow for a workflow scheme. That is, the default workflow is set to Jira's system workflow (the *jira* workflow).
+ *
+ * Note that active workflow schemes cannot be edited. If the workflow scheme is active, set `updateDraftIfNeeded` to `true` and a draft workflow scheme is created or updated with the default workflow reset. The draft workflow scheme can be published in Jira.
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ deleteDefaultWorkflow: {
+ parameters: {
+ query?: {
+ /** @description 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`. */
+ updateDraftIfNeeded?: boolean;
+ };
+ path: {
+ /** @description The ID of the workflow scheme. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["WorkflowScheme"];
+ };
+ };
+ /** @description Returned if the workflow scheme cannot be edited and `updateDraftIfNeeded` is not `true`. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the necessary permission. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the workflow scheme is not found. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get draft workflow scheme
+ * @description Returns the draft workflow scheme for an active workflow scheme. Draft workflow schemes allow changes to be made to the active workflow schemes: When an active workflow scheme is updated, a draft copy is created. The draft is modified, then the changes in the draft are copied back to the active workflow scheme. See [Configuring workflow schemes](https://confluence.atlassian.com/x/tohKLg) for more information.
+ * Note that:
+ *
+ * * Only active workflow schemes can have draft workflow schemes.
+ * * An active workflow scheme can only have one draft workflow scheme.
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ getWorkflowSchemeDraft: {
+ parameters: {
+ path: {
+ /** @description The ID of the active workflow scheme that the draft was created from. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["WorkflowScheme"];
+ };
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the necessary permission. */
+ 403: {
+ content: never;
+ };
+ /**
+ * @description Returned if:
+ *
+ * * the original active workflow scheme is not found.
+ * * the original active workflow scheme does not have a draft.
+ */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Update draft workflow scheme
+ * @description Updates a draft workflow scheme. If a draft workflow scheme does not exist for the active workflow scheme, then a draft is created. Note that an active workflow scheme can only have one draft workflow scheme.
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ updateWorkflowSchemeDraft: {
+ parameters: {
+ path: {
+ /** @description The ID of the active workflow scheme that the draft was created from. */
+ id: number;
+ };
+ };
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "defaultWorkflow": "jira",
+ * "description": "The description of the example workflow scheme.",
+ * "issueTypeMappings": {
+ * "10000": "scrum workflow"
+ * },
+ * "name": "Example workflow scheme",
+ * "updateDraftIfNeeded": false
+ * }
+ */
+ "application/json": components["schemas"]["WorkflowScheme"];
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["WorkflowScheme"];
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the necessary permission. */
+ 403: {
+ content: never;
+ };
+ /**
+ * @description Returned if:
+ *
+ * * the original active workflow scheme is not found.
+ * * the original active workflow scheme does not have a draft.
+ */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Delete draft workflow scheme
+ * @description Deletes a draft workflow scheme.
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ deleteWorkflowSchemeDraft: {
+ parameters: {
+ path: {
+ /** @description The ID of the active workflow scheme that the draft was created from. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 204: {
+ content: never;
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the necessary permission.. */
+ 403: {
+ content: never;
+ };
+ /**
+ * @description Returned if:
+ *
+ * * the original active workflow scheme is not found.
+ * * the original active workflow scheme does not have a draft.
+ */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get draft default workflow
+ * @description Returns the default workflow for a workflow scheme's draft. The default workflow is the workflow that is assigned any issue types that have not been mapped to any other workflow. The default workflow has *All Unassigned Issue Types* listed in its issue types for the workflow scheme in Jira.
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ getDraftDefaultWorkflow: {
+ parameters: {
+ path: {
+ /** @description The ID of the workflow scheme that the draft belongs to. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["DefaultWorkflow"];
+ };
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the necessary permission.. */
+ 403: {
+ content: never;
+ };
+ /**
+ * @description Returned if any of the following is true:
+ *
+ * * The workflow scheme is not found.
+ * * The workflow scheme does not have a draft.
+ */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Update draft default workflow
+ * @description Sets the default workflow for a workflow scheme's draft.
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ updateDraftDefaultWorkflow: {
+ parameters: {
+ path: {
+ /** @description The ID of the workflow scheme that the draft belongs to. */
+ id: number;
+ };
+ };
+ /** @description The object for the new default workflow. */
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "updateDraftIfNeeded": false,
+ * "workflow": "jira"
+ * }
+ */
+ "application/json": components["schemas"]["DefaultWorkflow"];
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["WorkflowScheme"];
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the necessary permission. */
+ 403: {
+ content: never;
+ };
+ /**
+ * @description Returned if any of the following is true:
+ *
+ * * The workflow scheme is not found.
+ * * The workflow scheme does not have a draft.
+ */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Delete draft default workflow
+ * @description Resets the default workflow for a workflow scheme's draft. That is, the default workflow is set to Jira's system workflow (the *jira* workflow).
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ deleteDraftDefaultWorkflow: {
+ parameters: {
+ path: {
+ /** @description The ID of the workflow scheme that the draft belongs to. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["WorkflowScheme"];
+ };
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the necessary permission. */
+ 403: {
+ content: never;
+ };
+ /**
+ * @description Returned if any of the following is true:
+ *
+ * * The workflow scheme is not found.
+ * * The workflow scheme does not have a draft.
+ */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get workflow for issue type in draft workflow scheme
+ * @description Returns the issue type-workflow mapping for an issue type in a workflow scheme's draft.
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ getWorkflowSchemeDraftIssueType: {
+ parameters: {
+ path: {
+ /** @description The ID of the workflow scheme that the draft belongs to. */
+ id: number;
+ /** @description The ID of the issue type. */
+ issueType: string;
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["IssueTypeWorkflowMapping"];
+ };
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the necessary permission. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the workflow scheme or issue type is not found. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Set workflow for issue type in draft workflow scheme
+ * @description Sets the workflow for an issue type in a workflow scheme's draft.
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ setWorkflowSchemeDraftIssueType: {
+ parameters: {
+ path: {
+ /** @description The ID of the workflow scheme that the draft belongs to. */
+ id: number;
+ /** @description The ID of the issue type. */
+ issueType: string;
+ };
+ };
+ /** @description The issue type-project mapping. */
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "issueType": "10000",
+ * "updateDraftIfNeeded": false,
+ * "workflow": "jira"
+ * }
+ */
+ "application/json": components["schemas"]["IssueTypeWorkflowMapping"];
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["WorkflowScheme"];
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the necessary permission. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the workflow scheme or issue type is not found. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Delete workflow for issue type in draft workflow scheme
+ * @description Deletes the issue type-workflow mapping for an issue type in a workflow scheme's draft.
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ deleteWorkflowSchemeDraftIssueType: {
+ parameters: {
+ path: {
+ /** @description The ID of the workflow scheme that the draft belongs to. */
+ id: number;
+ /** @description The ID of the issue type. */
+ issueType: string;
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["WorkflowScheme"];
+ };
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the necessary permission. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the workflow scheme or issue type is not found. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Publish draft workflow scheme
+ * @description Publishes a draft workflow scheme.
+ *
+ * Where the draft workflow includes new workflow statuses for an issue type, mappings are provided to update issues with the original workflow status to the new workflow status.
+ *
+ * This operation is [asynchronous](#async). Follow the `location` link in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain updates.
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ publishDraftWorkflowScheme: {
+ parameters: {
+ query?: {
+ /** @description Whether the request only performs a validation. */
+ validateOnly?: boolean;
+ };
+ path: {
+ /** @description The ID of the workflow scheme that the draft belongs to. */
+ id: number;
+ };
+ };
+ /** @description Details of the status mappings. */
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "statusMappings": [
+ * {
+ * "issueTypeId": "10001",
+ * "newStatusId": "1",
+ * "statusId": "3"
+ * },
+ * {
+ * "issueTypeId": "10001",
+ * "newStatusId": "2",
+ * "statusId": "2"
+ * },
+ * {
+ * "issueTypeId": "10002",
+ * "newStatusId": "10003",
+ * "statusId": "10005"
+ * },
+ * {
+ * "issueTypeId": "10003",
+ * "newStatusId": "1",
+ * "statusId": "4"
+ * }
+ * ]
+ * }
+ */
+ "application/json": components["schemas"]["PublishDraftWorkflowScheme"];
+ };
+ };
+ responses: {
+ /** @description Returned if the request is only for validation and is successful. */
+ 204: {
+ content: never;
+ };
+ /** @description Returned if the request is successful. */
+ 303: {
+ content: {
+ "application/json": components["schemas"]["TaskProgressBeanObject"];
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the necessary permission. */
+ 403: {
+ content: never;
+ };
+ /**
+ * @description Returned if any of these are true:
+ *
+ * * The workflow scheme is not found.
+ * * The workflow scheme does not have a draft.
+ * * A new status in the draft workflow scheme is not found.
+ */
+ 404: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ };
+ };
+ /**
+ * Get issue types for workflows in draft workflow scheme
+ * @description Returns the workflow-issue type mappings for a workflow scheme's draft.
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ getDraftWorkflow: {
+ parameters: {
+ query?: {
+ /** @description The name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow. */
+ workflowName?: string;
+ };
+ path: {
+ /** @description The ID of the workflow scheme that the draft belongs to. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["IssueTypesWorkflowMapping"];
+ };
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the necessary permission. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if either the workflow scheme or workflow (if specified) is not found. session. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Set issue types for workflow in workflow scheme
+ * @description Sets the issue types for a workflow in a workflow scheme's draft. The workflow can also be set as the default workflow for the draft workflow scheme. Unmapped issues types are mapped to the default workflow.
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ updateDraftWorkflowMapping: {
+ parameters: {
+ query: {
+ /** @description The name of the workflow. */
+ workflowName: string;
+ };
+ path: {
+ /** @description The ID of the workflow scheme that the draft belongs to. */
+ id: number;
+ };
+ };
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "issueTypes": [
+ * "10000"
+ * ],
+ * "updateDraftIfNeeded": true,
+ * "workflow": "jira"
+ * }
+ */
+ "application/json": components["schemas"]["IssueTypesWorkflowMapping"];
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["WorkflowScheme"];
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the necessary permission. */
+ 403: {
+ content: never;
+ };
+ /**
+ * @description Returned if any of the following is true:
+ *
+ * * The workflow scheme is not found.
+ * * The workflow scheme does not have a draft.
+ * * The workflow is not found.
+ * * The workflow is not specified.
+ */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Delete issue types for workflow in draft workflow scheme
+ * @description Deletes the workflow-issue type mapping for a workflow in a workflow scheme's draft.
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ deleteDraftWorkflowMapping: {
+ parameters: {
+ query: {
+ /** @description The name of the workflow. */
+ workflowName: string;
+ };
+ path: {
+ /** @description The ID of the workflow scheme that the draft belongs to. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: never;
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the necessary permission. */
+ 403: {
+ content: never;
+ };
+ /**
+ * @description Returned if any of the following is true:
+ *
+ * * The workflow scheme is not found.
+ * * The workflow scheme does not have a draft.
+ * * The workflow is not found.
+ * * The workflow is not specified.
+ */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get workflow for issue type in workflow scheme
+ * @description Returns the issue type-workflow mapping for an issue type in a workflow scheme.
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ getWorkflowSchemeIssueType: {
+ parameters: {
+ query?: {
+ /** @description 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. */
+ returnDraftIfExists?: boolean;
+ };
+ path: {
+ /** @description The ID of the workflow scheme. */
+ id: number;
+ /** @description The ID of the issue type. */
+ issueType: string;
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["IssueTypeWorkflowMapping"];
+ };
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the necessary permission. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the workflow scheme or issue type is not found. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Set workflow for issue type in workflow scheme
+ * @description Sets the workflow for an issue type in a workflow scheme.
+ *
+ * Note that active workflow schemes cannot be edited. If the workflow scheme is active, set `updateDraftIfNeeded` to `true` in the request body and a draft workflow scheme is created or updated with the new issue type-workflow mapping. The draft workflow scheme can be published in Jira.
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ setWorkflowSchemeIssueType: {
+ parameters: {
+ path: {
+ /** @description The ID of the workflow scheme. */
+ id: number;
+ /** @description The ID of the issue type. */
+ issueType: string;
+ };
+ };
+ /** @description The issue type-project mapping. */
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "issueType": "10000",
+ * "updateDraftIfNeeded": false,
+ * "workflow": "jira"
+ * }
+ */
+ "application/json": components["schemas"]["IssueTypeWorkflowMapping"];
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["WorkflowScheme"];
+ };
+ };
+ /** @description Returned if the workflow cannot be edited and `updateDraftIfNeeded` is false. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the necessary permission. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the workflow scheme or issue type is not found. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Delete workflow for issue type in workflow scheme
+ * @description Deletes the issue type-workflow mapping for an issue type in a workflow scheme.
+ *
+ * Note that active workflow schemes cannot be edited. If the workflow scheme is active, set `updateDraftIfNeeded` to `true` and a draft workflow scheme is created or updated with the issue type-workflow mapping deleted. The draft workflow scheme can be published in Jira.
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ deleteWorkflowSchemeIssueType: {
+ parameters: {
+ query?: {
+ /** @description 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`. */
+ updateDraftIfNeeded?: boolean;
+ };
+ path: {
+ /** @description The ID of the workflow scheme. */
+ id: number;
+ /** @description The ID of the issue type. */
+ issueType: string;
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["WorkflowScheme"];
+ };
+ };
+ /** @description Returned if the workflow cannot be edited and `updateDraftIfNeeded` is false. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the necessary permission. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the workflow scheme or issue type is not found. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get issue types for workflows in workflow scheme
+ * @description Returns the workflow-issue type mappings for a workflow scheme.
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ getWorkflow: {
+ parameters: {
+ query?: {
+ /** @description The name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow. */
+ workflowName?: string;
+ /** @description 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. */
+ returnDraftIfExists?: boolean;
+ };
+ path: {
+ /** @description The ID of the workflow scheme. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["IssueTypesWorkflowMapping"];
+ };
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the necessary permission. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if either the workflow scheme or workflow is not found. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Set issue types for workflow in workflow scheme
+ * @description Sets the issue types for a workflow in a workflow scheme. The workflow can also be set as the default workflow for the workflow scheme. Unmapped issues types are mapped to the default workflow.
+ *
+ * Note that active workflow schemes cannot be edited. If the workflow scheme is active, set `updateDraftIfNeeded` to `true` in the request body and a draft workflow scheme is created or updated with the new workflow-issue types mappings. The draft workflow scheme can be published in Jira.
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ updateWorkflowMapping: {
+ parameters: {
+ query: {
+ /** @description The name of the workflow. */
+ workflowName: string;
+ };
+ path: {
+ /** @description The ID of the workflow scheme. */
+ id: number;
+ };
+ };
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "issueTypes": [
+ * "10000"
+ * ],
+ * "updateDraftIfNeeded": true,
+ * "workflow": "jira"
+ * }
+ */
+ "application/json": components["schemas"]["IssueTypesWorkflowMapping"];
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["WorkflowScheme"];
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the necessary permission. */
+ 403: {
+ content: never;
+ };
+ /**
+ * @description Returned if any of the following is true:
+ *
+ * * The workflow scheme is not found.
+ * * The workflow is not found.
+ * * The workflow is not specified.
+ */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Delete issue types for workflow in workflow scheme
+ * @description Deletes the workflow-issue type mapping for a workflow in a workflow scheme.
+ *
+ * Note that active workflow schemes cannot be edited. If the workflow scheme is active, set `updateDraftIfNeeded` to `true` and a draft workflow scheme is created or updated with the workflow-issue type mapping deleted. The draft workflow scheme can be published in Jira.
+ *
+ * **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
+ */
+ deleteWorkflowMapping: {
+ parameters: {
+ query: {
+ /** @description The name of the workflow. */
+ workflowName: string;
+ /** @description 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`. */
+ updateDraftIfNeeded?: boolean;
+ };
+ path: {
+ /** @description The ID of the workflow scheme. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: never;
+ };
+ /** @description Returned if the workflow cannot be edited and `updateDraftIfNeeded` is not true. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have the necessary permission. */
+ 403: {
+ content: never;
+ };
+ /**
+ * @description Returned if any of the following is true:
+ *
+ * * The workflow scheme is not found.
+ * * The workflow is not found.
+ * * The workflow is not specified.
+ */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get IDs of deleted worklogs
+ * @description Returns a list of IDs and delete timestamps for worklogs deleted after a date and time.
+ *
+ * This resource is paginated, with a limit of 1000 worklogs per page. Each page lists worklogs from oldest to youngest. If the number of items in the date range exceeds 1000, `until` indicates the timestamp of the youngest item on the page. Also, `nextPage` provides the URL for the next page of worklogs. The `lastPage` parameter is set to true on the last page of worklogs.
+ *
+ * This resource does not return worklogs deleted during the minute preceding the request.
+ *
+ * **[Permissions](#permissions) required:** Permission to access Jira.
+ */
+ getIdsOfWorklogsDeletedSince: {
+ parameters: {
+ query?: {
+ /** @description The date and time, as a UNIX timestamp in milliseconds, after which deleted worklogs are returned. */
+ since?: number;
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["ChangedWorklogs"];
+ };
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get worklogs
+ * @description Returns worklog details for a list of worklog IDs.
+ *
+ * The returned list of worklogs is limited to 1000 items.
+ *
+ * **[Permissions](#permissions) required:** Permission to access Jira, however, worklogs are only returned where either of the following is true:
+ *
+ * * the worklog is set as *Viewable by All Users*.
+ * * the user is a member of a project role or group with permission to view the worklog.
+ */
+ getWorklogsForIds: {
+ parameters: {
+ query?: {
+ /** @description Use [expand](#expansion) to include additional information about worklogs in the response. This parameter accepts `properties` that returns the properties of each worklog. */
+ expand?: string;
+ };
+ };
+ /** @description A JSON object containing a list of worklog IDs. */
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "ids": [
+ * 1,
+ * 2,
+ * 5,
+ * 10
+ * ]
+ * }
+ */
+ "application/json": components["schemas"]["WorklogIdsRequestBean"];
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["Worklog"][];
+ };
+ };
+ /** @description Returned if the request contains more than 1000 worklog IDs or is empty. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get IDs of updated worklogs
+ * @description Returns a list of IDs and update timestamps for worklogs updated after a date and time.
+ *
+ * This resource is paginated, with a limit of 1000 worklogs per page. Each page lists worklogs from oldest to youngest. If the number of items in the date range exceeds 1000, `until` indicates the timestamp of the youngest item on the page. Also, `nextPage` provides the URL for the next page of worklogs. The `lastPage` parameter is set to true on the last page of worklogs.
+ *
+ * This resource does not return worklogs updated during the minute preceding the request.
+ *
+ * **[Permissions](#permissions) required:** Permission to access Jira, however, worklogs are only returned where either of the following is true:
+ *
+ * * the worklog is set as *Viewable by All Users*.
+ * * the user is a member of a project role or group with permission to view the worklog.
+ */
+ getIdsOfWorklogsModifiedSince: {
+ parameters: {
+ query?: {
+ /** @description The date and time, as a UNIX timestamp in milliseconds, after which updated worklogs are returned. */
+ since?: number;
+ /** @description Use [expand](#expansion) to include additional information about worklogs in the response. This parameter accepts `properties` that returns the properties of each worklog. */
+ expand?: string;
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["ChangedWorklogs"];
+ };
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get app properties
+ * @description Gets all the properties of an app.
+ *
+ * **[Permissions](#permissions) required:** Only a Connect app whose key matches `addonKey` can make this request.
+ * Additionally, Forge apps published on the Marketplace can access properties of Connect apps they were [migrated from](https://developer.atlassian.com/platform/forge/build-a-connect-on-forge-app/).
+ */
+ "AddonPropertiesResource.getAddonProperties_get": {
+ parameters: {
+ path: {
+ /** @description The key of the app, as defined in its descriptor. */
+ addonKey: string;
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["PropertyKeys"];
+ };
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["OperationMessage"];
+ };
+ };
+ };
+ };
+ /**
+ * Get app property
+ * @description Returns the key and value of an app's property.
+ *
+ * **[Permissions](#permissions) required:** Only a Connect app whose key matches `addonKey` can make this request.
+ * Additionally, Forge apps published on the Marketplace can access properties of Connect apps they were [migrated from](https://developer.atlassian.com/platform/forge/build-a-connect-on-forge-app/).
+ */
+ "AddonPropertiesResource.getAddonProperty_get": {
+ parameters: {
+ path: {
+ /** @description The key of the app, as defined in its descriptor. */
+ addonKey: string;
+ /** @description The key of the property. */
+ propertyKey: string;
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["EntityProperty"];
+ };
+ };
+ /** @description Returned if the property key is longer than 127 characters. */
+ 400: {
+ content: {
+ "application/json": components["schemas"]["OperationMessage"];
+ };
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["OperationMessage"];
+ };
+ };
+ /** @description Returned if the property is not found or doesn't belong to the app. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["OperationMessage"];
+ };
+ };
+ };
+ };
+ /**
+ * Set app property
+ * @description Sets the value of an app's property. Use this resource to store custom data for your app.
+ *
+ * The value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters.
+ *
+ * **[Permissions](#permissions) required:** Only a Connect app whose key matches `addonKey` can make this request.
+ */
+ "AddonPropertiesResource.putAddonProperty_put": {
+ parameters: {
+ path: {
+ /** @description The key of the app, as defined in its descriptor. */
+ addonKey: string;
+ /** @description The key of the property. */
+ propertyKey: string;
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ responses: {
+ /** @description Returned if the property is updated. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["OperationMessage"];
+ };
+ };
+ /** @description Returned is the property is created. */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["OperationMessage"];
+ };
+ };
+ /**
+ * @description Returned if:
+ * * the property key is longer than 127 characters.
+ * * the value is not valid JSON.
+ * * the value is longer than 32768 characters.
+ */
+ 400: {
+ content: {
+ "application/json": components["schemas"]["OperationMessage"];
+ };
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["OperationMessage"];
+ };
+ };
+ };
+ };
+ /**
+ * Delete app property
+ * @description Deletes an app's property.
+ *
+ * **[Permissions](#permissions) required:** Only a Connect app whose key matches `addonKey` can make this request.
+ */
+ "AddonPropertiesResource.deleteAddonProperty_delete": {
+ parameters: {
+ path: {
+ /** @description The key of the app, as defined in its descriptor. */
+ addonKey: string;
+ /** @description The key of the property. */
+ propertyKey: string;
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 204: {
+ content: never;
+ };
+ /** @description Returned if the property key is longer than 127 characters. */
+ 400: {
+ content: {
+ "application/json": components["schemas"]["OperationMessage"];
+ };
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["OperationMessage"];
+ };
+ };
+ /** @description Returned if the property is not found or doesn't belong to the app. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["OperationMessage"];
+ };
+ };
+ };
+ };
+ /**
+ * Get modules
+ * @description Returns all modules registered dynamically by the calling app.
+ *
+ * **[Permissions](#permissions) required:** Only Connect apps can make this request.
+ */
+ "DynamicModulesResource.getModules_get": {
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["ConnectModules"];
+ };
+ };
+ /** @description Returned if the call is not from a Connect app. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorMessage"];
+ };
+ };
+ };
+ };
+ /**
+ * Register modules
+ * @description Registers a list of modules.
+ *
+ * **[Permissions](#permissions) required:** Only Connect apps can make this request.
+ */
+ "DynamicModulesResource.registerModules_post": {
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["ConnectModules"];
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: never;
+ };
+ /**
+ * @description Returned if:
+ * * any of the provided modules is invalid. For example, required properties are missing.
+ * * any of the modules conflict with registered dynamic modules or modules defined in the app descriptor. For example, there are duplicate keys.
+ *
+ * Details of the issues encountered are included in the error message.
+ */
+ 400: {
+ content: {
+ "application/json": components["schemas"]["ErrorMessage"];
+ };
+ };
+ /** @description Returned if the call is not from a Connect app. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorMessage"];
+ };
+ };
+ };
+ };
+ /**
+ * Remove modules
+ * @description Remove all or a list of modules registered by the calling app.
+ *
+ * **[Permissions](#permissions) required:** Only Connect apps can make this request.
+ */
+ "DynamicModulesResource.removeModules_delete": {
+ parameters: {
+ query?: {
+ /**
+ * @description 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.
+ */
+ moduleKey?: string[];
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 204: {
+ content: never;
+ };
+ /** @description Returned if the call is not from a Connect app. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorMessage"];
+ };
+ };
+ };
+ };
+ /**
+ * Bulk update custom field value
+ * @description Updates the value of a custom field added by Connect apps on one or more issues.
+ * The values of up to 200 custom fields can be updated.
+ *
+ * **[Permissions](#permissions) required:** Only Connect apps can make this request
+ */
+ "AppIssueFieldValueUpdateResource.updateIssueFields_put": {
+ parameters: {
+ header: {
+ /** @description The ID of the transfer. */
+ "Atlassian-Transfer-Id": string;
+ };
+ };
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "updateValueList": [
+ * {
+ * "_type": "StringIssueField",
+ * "issueID": 10001,
+ * "fieldID": 10076,
+ * "string": "new string value"
+ * },
+ * {
+ * "_type": "TextIssueField",
+ * "issueID": 10002,
+ * "fieldID": 10077,
+ * "text": "new text value"
+ * },
+ * {
+ * "_type": "SingleSelectIssueField",
+ * "issueID": 10003,
+ * "fieldID": 10078,
+ * "optionID": "1"
+ * },
+ * {
+ * "_type": "MultiSelectIssueField",
+ * "issueID": 10004,
+ * "fieldID": 10079,
+ * "optionID": "2"
+ * },
+ * {
+ * "_type": "RichTextIssueField",
+ * "issueID": 10005,
+ * "fieldID": 10080,
+ * "richText": "new rich text value"
+ * },
+ * {
+ * "_type": "NumberIssueField",
+ * "issueID": 10006,
+ * "fieldID": 10082,
+ * "number": 54
+ * }
+ * ]
+ * }
+ */
+ "application/json": components["schemas"]["ConnectCustomFieldValues"];
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /**
+ * @description Returned if:
+ * * the transfer ID is not found.
+ * * the authorisation credentials are incorrect or missing.
+ */
+ 403: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Bulk update entity properties
+ * @description Updates the values of multiple entity properties for an object, up to 50 updates per request. This operation is for use by Connect apps during app migration.
+ */
+ "MigrationResource.updateEntityPropertiesValue_put": {
+ parameters: {
+ header: {
+ /** @description The app migration transfer ID. */
+ "Atlassian-Transfer-Id": string;
+ };
+ path: {
+ /** @description The type indicating the object that contains the entity properties. */
+ entityType:
+ | "IssueProperty"
+ | "CommentProperty"
+ | "DashboardItemProperty"
+ | "IssueTypeProperty"
+ | "ProjectProperty"
+ | "UserProperty"
+ | "WorklogProperty"
+ | "BoardProperty"
+ | "SprintProperty";
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["EntityPropertyDetails"][];
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: never;
+ };
+ /** @description Returned if the request is not valid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the authorisation credentials are incorrect or missing. */
+ 403: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get workflow transition rule configurations
+ * @description Returns configurations for workflow transition rules migrated from server to cloud and owned by the calling Connect app.
+ */
+ "MigrationResource.workflowRuleSearch_post": {
+ parameters: {
+ header: {
+ /** @description The app migration transfer ID. */
+ "Atlassian-Transfer-Id": string;
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["WorkflowRulesSearch"];
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["WorkflowRulesSearchDetails"];
+ };
+ };
+ /** @description Returned if the request is not valid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the authorisation credentials are incorrect or missing. */
+ 403: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Retrieve the attributes of service registries
+ * @description Retrieve the attributes of given service registries.
+ *
+ * **[Permissions](#permissions) required:** Only Connect apps can make this request and the servicesIds belong to the tenant you are requesting
+ */
+ "ServiceRegistryResource.services_get": {
+ parameters: {
+ query: {
+ /**
+ * @description The ID of the services (the strings starting with "b:" need to be decoded in Base64).
+ * @example ["ari:cloud:graph::service/ca075ed7-6ea7-4563-acb3-000000000000/f51d7252-61e0-11ee-b94d-000000000000", "ari:cloud:graph::service/ca075ed7-6ea7-4563-acb3-000000000000/f51d7252-61e0-11ee-b94d-000000000001"]
+ */
+ serviceIds: string[];
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["ServiceRegistry"][];
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description The request needs to be authenticated. */
+ 401: {
+ content: never;
+ };
+ /** @description The request isn't authorized. */
+ 403: {
+ content: never;
+ };
+ /** @description The endpoint failed internally. */
+ 500: {
+ content: never;
+ };
+ /** @description The endpoint isn't ready for receiving requests. */
+ 501: {
+ content: never;
+ };
+ /** @description The upstream service is busy. */
+ 504: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Set app property (Forge)
+ * @description Sets the value of a Forge app's property.
+ * These values can be retrieved in [Jira expressions](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/)
+ * through the `app` [context variable](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#context-variables).
+ *
+ * For other use cases, use the [Storage API](https://developer.atlassian.com/platform/forge/runtime-reference/storage-api/).
+ *
+ * The value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters.
+ *
+ * **[Permissions](#permissions) required:** Only Forge apps can make this request.
+ */
+ "AddonPropertiesResource.putAppProperty_put": {
+ parameters: {
+ path: {
+ /** @description The key of the property. */
+ propertyKey: string;
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ responses: {
+ /** @description Returned if the property is updated. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["OperationMessage"];
+ };
+ };
+ /** @description Returned is the property is created. */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["OperationMessage"];
+ };
+ };
+ /**
+ * @description Returned if:
+ * * the property key is longer than 127 characters.
+ * * the value isn't valid JSON.
+ * * the value is longer than 32768 characters.
+ */
+ 400: {
+ content: {
+ "application/json": components["schemas"]["OperationMessage"];
+ };
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the request isn't made directly by an app or if it's an impersonated request. */
+ 403: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ };
+ };
+ /**
+ * Delete app property (Forge)
+ * @description Deletes a Forge app's property.
+ *
+ * **[Permissions](#permissions) required:** Only Forge apps can make this request.
+ */
+ "AddonPropertiesResource.deleteAppProperty_delete": {
+ parameters: {
+ path: {
+ /** @description The key of the property. */
+ propertyKey: string;
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 204: {
+ content: never;
+ };
+ /** @description Returned if the property key is longer than 127 characters. */
+ 400: {
+ content: {
+ "application/json": components["schemas"]["OperationMessage"];
+ };
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the request isn't made directly by an app or if it's an impersonated request. */
+ 403: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the property isn't found or doesn't belong to the app. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["OperationMessage"];
+ };
+ };
+ };
+ };
+}
diff --git a/src/generated/openapi-server.ts b/src/generated/openapi-server.ts
new file mode 100644
index 0000000..f300064
--- /dev/null
+++ b/src/generated/openapi-server.ts
@@ -0,0 +1,9275 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+export interface paths {
+ "/api/2/application-properties": {
+ /** @description Returns an application property. */
+ get: operations["getProperty"];
+ };
+ "/api/2/application-properties/advanced-settings": {
+ /** @description Returns the properties that are displayed on the "General Configuration > Advanced Settings" page. */
+ get: operations["getAdvancedSettings"];
+ };
+ "/api/2/application-properties/{id}": {
+ /** @description Modify an application property via PUT. The "value" field present in the PUT will override the existing value. */
+ put: operations["setPropertyViaRestfulTable"];
+ parameters: {
+ path: {
+ id: string;
+ };
+ };
+ };
+ "/api/2/applicationrole": {
+ /**
+ * @description Returns all ApplicationRoles in the system. Will also return an ETag header containing a version hash of the
+ * collection of ApplicationRoles.
+ */
+ get: operations["getAll"];
+ /**
+ * @description Updates the ApplicationRoles with the passed data if the version hash is the same as the server.
+ * Only the groups and default groups setting of the role may be updated. Requests to change the key
+ * or the name of the role will be silently ignored. It is acceptable to pass only the roles that are updated
+ * as roles that are present in the server but not in data to update with, will not be deleted.
+ */
+ put: operations["putBulk"];
+ };
+ "/api/2/applicationrole/{key}": {
+ /** @description Returns the ApplicationRole with passed key if it exists. */
+ get: operations["get"];
+ /**
+ * @description Updates the ApplicationRole with the passed data. Only the groups and default groups setting of the
+ * role may be updated. Requests to change the key or the name of the role will be silently ignored.
+ *
+ * Optional: If versionHash is passed through the If-Match header the request will be rejected if not the
+ * same as server
+ */
+ put: operations["put"];
+ parameters: {
+ path: {
+ /** @description the key of the role to update. */
+ key: string;
+ };
+ };
+ };
+ "/api/2/attachment/meta": {
+ /**
+ * @description Returns the meta information for an attachments, specifically if they are enabled and the maximum upload size
+ * allowed.
+ */
+ get: operations["getAttachmentMeta"];
+ };
+ "/api/2/attachment/{id}": {
+ /** @description Returns the meta-data for an attachment, including the URI of the actual attached file. */
+ get: operations["getAttachment"];
+ /** @description Remove an attachment from an issue. */
+ delete: operations["removeAttachment"];
+ parameters: {
+ path: {
+ /** @description id of the attachment to remove */
+ id: string;
+ };
+ };
+ };
+ "/api/2/attachment/{id}/expand/human": {
+ /** @description Tries to expand an attachment. Output is human-readable and subject to change. */
+ get: operations["expandForHumans"];
+ parameters: {
+ path: {
+ /** @description the id of the attachment to expand. */
+ id: string;
+ };
+ };
+ };
+ "/api/2/attachment/{id}/expand/raw": {
+ /** @description Tries to expand an attachment. Output is raw and should be backwards-compatible through the course of time. */
+ get: operations["expandForMachines"];
+ parameters: {
+ path: {
+ /** @description the id of the attachment to expand. */
+ id: string;
+ };
+ };
+ };
+ "/api/2/auditing/record": {
+ /** @description Returns auditing records filtered using provided parameters */
+ get: operations["getRecords"];
+ /** @description Store a record in audit log */
+ post: operations["addRecord"];
+ };
+ "/api/2/avatar/{type}/system": {
+ /** @description Returns all system avatars of the given type. */
+ get: operations["getAllSystemAvatars"];
+ parameters: {
+ path: {
+ /** @description the avatar type */
+ type: string;
+ };
+ };
+ };
+ "/api/2/avatar/{type}/temporary": {
+ /** @description Creates temporary avatar */
+ post: operations["storeTemporaryAvatar"];
+ parameters: {
+ path: {
+ /** @description the avatar type */
+ type: string;
+ };
+ };
+ };
+ "/api/2/avatar/{type}/temporaryCrop": {
+ /** @description Updates the cropping instructions of the temporary avatar. */
+ post: operations["createAvatarFromTemporary"];
+ parameters: {
+ path: {
+ /** @description the avatar type */
+ type: string;
+ };
+ };
+ };
+ "/api/2/cluster/index-snapshot/{nodeId}": {
+ /** @description request current index from node (the request is processed asynchronously) */
+ put: operations["requestCurrentIndexFromNode"];
+ parameters: {
+ path: {
+ nodeId: string;
+ };
+ };
+ };
+ "/api/2/cluster/node/{nodeId}": {
+ /** @description Delete the node from the cluster if state of node is OFFLINE. */
+ delete: operations["deleteNode"];
+ parameters: {
+ path: {
+ nodeId: string;
+ };
+ };
+ };
+ "/api/2/cluster/node/{nodeId}/offline": {
+ /**
+ * @description Change the node's state to offline if the node is reporting as active, but is not alive.
+ * Don't use this method as an equivalent of running ./stop-jira.sh. This method doesn't shut down
+ * a node, but only changes its state, so that other nodes don't communicate with it.
+ */
+ put: operations["changeNodeStateToOffline"];
+ parameters: {
+ path: {
+ nodeId: string;
+ };
+ };
+ };
+ "/api/2/cluster/nodes": {
+ get: operations["getAllNodes"];
+ };
+ "/api/2/cluster/zdu/approve": {
+ post: operations["approveUpgrade"];
+ };
+ "/api/2/cluster/zdu/cancel": {
+ post: operations["cancelUpgrade"];
+ };
+ "/api/2/cluster/zdu/retryUpgrade": {
+ post: operations["acknowledgeErrors"];
+ };
+ "/api/2/cluster/zdu/start": {
+ post: operations["setReadyToUpgrade"];
+ };
+ "/api/2/cluster/zdu/state": {
+ get: operations["getState"];
+ };
+ "/api/2/comment/{commentId}/properties": {
+ /** @description Returns the keys of all properties for the comment identified by the key or by the id. */
+ get: operations["getPropertiesKeys"];
+ parameters: {
+ path: {
+ /** @description the comment from which keys will be returned. */
+ commentId: string;
+ };
+ };
+ };
+ "/api/2/comment/{commentId}/properties/{propertyKey}": {
+ /**
+ * @description Returns the value of the property with a given key from the comment identified by the key or by the id. The user who retrieves
+ * the property is required to have permissions to read the comment.
+ */
+ get: operations["getProperty"];
+ /**
+ * @description Sets the value of the specified comment's property.
+ *
+ * You can use this resource to store a custom data against the comment identified by the key or by the id. The user
+ * who stores the data is required to have permissions to administer the comment.
+ *
+ */
+ put: operations["setProperty"];
+ /**
+ * @description Removes the property from the comment identified by the key or by the id. Ths user removing the property is required
+ * to have permissions to administer the comment.
+ */
+ delete: operations["deleteProperty"];
+ parameters: {
+ path: {
+ /** @description the comment from which keys will be returned. */
+ commentId: string;
+ /** @description the key of the property to return. */
+ propertyKey: string;
+ };
+ };
+ };
+ "/api/2/component": {
+ /** @description Create a component via POST. */
+ post: operations["createComponent"];
+ };
+ "/api/2/component/page": {
+ /** @description Returns paginated list of filtered active components */
+ get: operations["getPaginatedComponents"];
+ };
+ "/api/2/component/{id}": {
+ /** @description Returns a project component. */
+ get: operations["getComponent"];
+ /**
+ * @description Modify a component via PUT. Any fields present in the PUT will override existing values. As a convenience, if a field
+ * is not present, it is silently ignored.
+ *
+ * If leadUserName is an empty string ("") the component lead will be removed.
+ */
+ put: operations["updateComponent"];
+ /** @description Delete a project component. */
+ delete: operations["delete"];
+ parameters: {
+ path: {
+ /** @description The component to delete. */
+ id: string;
+ };
+ };
+ };
+ "/api/2/component/{id}/relatedIssueCounts": {
+ /** @description Returns counts of issues related to this component. */
+ get: operations["getComponentRelatedIssues"];
+ parameters: {
+ path: {
+ /** @description a String containing the component id */
+ id: string;
+ };
+ };
+ };
+ "/api/2/configuration": {
+ /**
+ * @description Returns the information if the optional features in Jira are enabled or disabled. If the time tracking is enabled,
+ * it also returns the detailed information about time tracking configuration.
+ */
+ get: operations["getConfiguration"];
+ };
+ "/api/2/customFieldOption/{id}": {
+ /** @description Returns a full representation of the Custom Field Option that has the given id. */
+ get: operations["getCustomFieldOption"];
+ parameters: {
+ path: {
+ /** @description a String containing an Custom Field Option id */
+ id: string;
+ };
+ };
+ };
+ "/api/2/customFields": {
+ get: operations["getCustomFields"];
+ delete: operations["bulkDeleteCustomFields"];
+ };
+ "/api/2/customFields/{customFieldId}/options": {
+ /**
+ * @description Returns custom field's options defined in a given context composed of projects and issue types.
+ *
+ * If the projects and issue types match more than one context or the context for such a combination does not exist then no options are returned.
+ */
+ get: operations["getCustomFieldOptions"];
+ parameters: {
+ path: {
+ /** @description id of a custom field. */
+ customFieldId: number;
+ };
+ };
+ };
+ "/api/2/dashboard": {
+ /** @description Returns a list of all dashboards, optionally filtering them. */
+ get: operations["list"];
+ };
+ "/api/2/dashboard/{dashboardId}/items/{itemId}/properties": {
+ /** @description Returns the keys of all properties for the dashboard item identified by the id. */
+ get: operations["getPropertiesKeys"];
+ parameters: {
+ path: {
+ /** @description the dashboard item from which keys will be returned. */
+ itemId: string;
+ dashboardId: string;
+ };
+ };
+ };
+ "/api/2/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}": {
+ /**
+ * @description Returns the value of the property with a given key from the dashboard item identified by the id.
+ * The user who retrieves the property is required to have permissions to read the dashboard item.
+ */
+ get: operations["getProperty"];
+ /**
+ * @description Sets the value of the specified dashboard item's property.
+ *
+ * You can use this resource to store a custom data against the dashboard item identified by the id.
+ * The user who stores the data is required to have permissions to administer the dashboard item.
+ *
+ */
+ put: operations["setProperty"];
+ /**
+ * @description Removes the property from the dashboard item identified by the key or by the id. Ths user removing the property is required
+ * to have permissions to administer the dashboard item.
+ */
+ delete: operations["deleteProperty"];
+ parameters: {
+ path: {
+ /** @description the dashboard item from which keys will be returned. */
+ itemId: string;
+ dashboardId: string;
+ /** @description the key of the property to return. */
+ propertyKey: string;
+ };
+ };
+ };
+ "/api/2/dashboard/{id}": {
+ /** @description Returns a single dashboard. */
+ get: operations["getDashboard"];
+ parameters: {
+ path: {
+ /** @description the dashboard id */
+ id: string;
+ };
+ };
+ };
+ "/api/2/email-templates": {
+ /** @description Creates a zip file containing email templates at local home and returns the file. */
+ get: operations["downloadEmailTemplates"];
+ /** @description Extracts given zip file to temporary templates folder. If the folder already exists it will replace it's content */
+ post: operations["uploadEmailTemplates"];
+ };
+ "/api/2/email-templates/apply": {
+ /** @description Replaces the current email templates pack with previously uploaded one, if exists. */
+ post: operations["applyEmailTemplates"];
+ };
+ "/api/2/email-templates/revert": {
+ /** @description Replaces the current email templates pack with default templates, which are copied over from Jira binaries. */
+ post: operations["revertEmailTemplatesToDefault"];
+ };
+ "/api/2/email-templates/types": {
+ /** @description Returns a list of root templates mapped with Event Types. The list can be used to decide which test emails to send. */
+ get: operations["getEmailTypes"];
+ };
+ "/api/2/field": {
+ /** @description Returns a list of all fields, both System and Custom */
+ get: operations["getFields"];
+ /** @description Creates a custom field using a definition (object encapsulating custom field data) */
+ post: operations["createCustomField"];
+ };
+ "/api/2/filter": {
+ /**
+ * @description Creates a new filter, and returns newly created filter.
+ * Currently sets permissions just using the users default sharing permissions
+ */
+ post: operations["createFilter"];
+ };
+ "/api/2/filter/defaultShareScope": {
+ /** @description Returns the default share scope of the logged-in user. */
+ get: operations["getDefaultShareScope"];
+ /**
+ * @description Sets the default share scope of the logged-in user.
+ *
+ * Available values are: AUTHENTICATED (for sharing with all logged-in users) and PRIVATE (for no shares).
+ */
+ put: operations["setDefaultShareScope"];
+ };
+ "/api/2/filter/favourite": {
+ /** @description Returns the favourite filters of the logged-in user. */
+ get: operations["getFavouriteFilters"];
+ };
+ "/api/2/filter/{id}": {
+ /** @description Returns a filter given an id */
+ get: operations["getFilter"];
+ /**
+ * @description Updates an existing filter, and returns its new value.
+ *
+ * The following properties of a filter can be updated: 'jql', 'name', 'description'.
+ * Additionally, administrators can also update the 'owner' field.
+ * To get, set or unset 'favourite', use rest/api/1.0/filters/{id}/favourite with GET, PUT and DELETE methods instead.
+ *
+ */
+ put: operations["editFilter"];
+ /** @description Delete a filter. */
+ delete: operations["deleteFilter"];
+ parameters: {
+ path: {
+ /** @description the id of the filter being looked up */
+ id: number;
+ };
+ };
+ };
+ "/api/2/filter/{id}/columns": {
+ /**
+ * @description Returns the default columns for the given filter. Currently logged in user will be used as
+ * the user making such request.
+ */
+ get: operations["defaultColumns"];
+ /** @description Sets the default columns for the given filter. */
+ put: operations["setColumns"];
+ /** @description Resets the columns for the given filter such that the filter no longer has its own column config. */
+ delete: operations["resetColumns"];
+ parameters: {
+ path: {
+ /** @description id of the filter */
+ id: number;
+ };
+ };
+ };
+ "/api/2/filter/{id}/permission": {
+ /** @description Returns all share permissions of the given filter. */
+ get: operations["getSharePermissions"];
+ /** @description Adds a share permissions to the given filter. Adding a global permission removes all previous permissions from the filter. */
+ post: operations["addSharePermission"];
+ parameters: {
+ path: {
+ id: number;
+ };
+ };
+ };
+ "/api/2/filter/{id}/permission/{permission-id}": {
+ /** @description Removes a share permissions from the given filter. */
+ delete: operations["deleteSharePermission"];
+ parameters: {
+ path: {
+ id: number;
+ "permission-id": number;
+ };
+ };
+ };
+ "/api/2/filter/{id}/permission/{permissionId}": {
+ /** @description Returns a single share permission of the given filter. */
+ get: operations["getSharePermission"];
+ parameters: {
+ path: {
+ permissionId: number;
+ id: number;
+ };
+ };
+ };
+ "/api/2/group": {
+ /**
+ * @description Returns REST representation for the requested group. Allows to get list of active users belonging to the
+ * specified group and its subgroups if "users" expand option is provided. You can page through users list by using
+ * indexes in expand param. For example to get users from index 10 to index 15 use "users[10:15]" expand value. This
+ * will return 6 users (if there are at least 16 users in this group). Indexes are 0-based and inclusive.
+ *
+ * This resource is deprecated, please use group/member API instead.
+ */
+ get: operations["getGroup"];
+ /**
+ * @description Creates a group by given group parameter
+ *
+ * Returns REST representation for the requested group.
+ */
+ post: operations["createGroup"];
+ /**
+ * @description Deletes a group by given group parameter.
+ *
+ * Returns no content
+ */
+ delete: operations["removeGroup"];
+ };
+ "/api/2/group/member": {
+ /**
+ * @description This resource returns a paginated list of users who are members of the specified group and its subgroups.
+ * Users in the page are ordered by user names. User of this resource is required to have sysadmin or admin permissions.
+ */
+ get: operations["getUsersFromGroup"];
+ };
+ "/api/2/group/user": {
+ /**
+ * @description Adds given user to a group.
+ *
+ * Returns the current state of the group.
+ */
+ post: operations["addUserToGroup"];
+ /**
+ * @description Removes given user from a group.
+ *
+ * Returns no content
+ */
+ delete: operations["removeUserFromGroup"];
+ };
+ "/api/2/groups/picker": {
+ /**
+ * @description Returns groups with substrings matching a given query. This is mainly for use with
+ * the group picker, so the returned groups contain html to be used as picker suggestions.
+ * The groups are also wrapped in a single response object that also contains a header for
+ * use in the picker, specifically Showing X of Y matching groups.
+ *
+ * The number of groups returned is limited by the system property "jira.ajax.autocomplete.limit"
+ *
+ * The groups will be unique and sorted.
+ */
+ get: operations["findGroups"];
+ };
+ "/api/2/groupuserpicker": {
+ /**
+ * @description Returns a list of users and groups matching query with highlighting. This resource cannot be accessed
+ * anonymously.
+ */
+ get: operations["findUsersAndGroups"];
+ };
+ "/api/2/index-snapshot": {
+ /**
+ * @description Lists available index snapshots absolute paths with timestamps.
+ *
+ * Only System Administrator can request listing index snapshots.
+ */
+ get: operations["listIndexSnapshot"];
+ /**
+ * @description Tries to start taking an index snapshot if no other snapshot creation process is in progress.
+ * Performs a cleanup of index snapshots directory so only a limited number of most recent snapshots are persisted.
+ * If another snapshot creation process is in progress, returns 409 without waiting for the other process to complete.
+ *
+ * Only System Administrator can request creation of snapshot. There is no guarantee as to the time after which the snapshot will be available.
+ */
+ post: operations["createIndexSnapshot"];
+ };
+ "/api/2/index-snapshot/isRunning": {
+ /**
+ * @description Answers true if index snapshot creation is currently running.
+ *
+ * Only System Administrator can request current snapshot creation status.
+ */
+ get: operations["isIndexSnapshotRunning"];
+ };
+ "/api/2/index/summary": {
+ /**
+ * @description Summarizes index condition of current node.
+ *
+ * Returned data consists of:
+ *
+ * nodeId - Node identifier.reportTime - Time of this report creation.issueIndex - Summary of issue index status.replicationQueues - Map of index replication queues, where
+ * keys represent nodes from which replication operations came from.
+ *
+ * issueIndex can contain:
+ *
+ * indexReadable - If false the end point failed to read data from issue index
+ * (check Jira logs for detailed stack trace), otherwise true.
+ * When false other fields of issueIndex can be not visible.countInDatabase - Count of issues found in database.countInIndex - Count of issues found while querying index.lastUpdatedInDatabase - Time of last update of issue found in database.lastUpdatedInIndex - Time of last update of issue found while querying index.
+ *
+ * replicationQueues's map values can contain:
+ *
+ * lastConsumedOperation - Last executed index replication operation by current node from sending node's queue.lastConsumedOperation.id - Identifier of the operation.lastConsumedOperation.replicationTime - Time when the operation was sent to other nodes.lastOperationInQueue - Last index replication operation in sending node's queue.lastOperationInQueue.id - Identifier of the operation.lastOperationInQueue.replicationTime - Time when the operation was sent to other nodes.queueSize - Number of operations in queue from sending node to current node.
+ */
+ get: operations["getIndexSummary"];
+ };
+ "/api/2/issue": {
+ /**
+ * @description Creates an issue or a sub-task from a JSON representation.
+ *
+ * The fields that can be set on create, in either the fields parameter or the update parameter can be determined
+ * using the /rest/api/2/issue/createmeta resource.
+ * If a field is not configured to appear on the create screen, then it will not be in the createmeta, and a field
+ * validation error will occur if it is submitted.
+ *
+ * Creating a sub-task is similar to creating a regular issue, with two important differences:
+ *
+ * - the
issueType field must correspond to a sub-task issue type (you can use
+ * /issue/createmeta to discover sub-task issue types), and
+ * - you must provide a
parent field in the issue create request containing the id or key of the
+ * parent issue.
+ * - The
updateHistory param adds the project that this issue is created in, to the current user's project history,
+ * if set to true (by default, the project history is not updated).
+ * - You can view the project history in the Jira application, via the Projects dropdown.
+ *
+ */
+ post: operations["createIssue"];
+ };
+ "/api/2/issue/archive": {
+ /** @description Archives a list of issues. */
+ post: operations["archiveIssues"];
+ };
+ "/api/2/issue/bulk": {
+ /**
+ * @description Creates issues or sub-tasks from a JSON representation.
+ *
+ * Creates many issues in one bulk operation.
+ *
+ * Creating a sub-task is similar to creating a regular issue. More details can be found in createIssue section:
+ * {@link IssueResource#createIssue(boolean, IssueUpdateBean)}}}
+ */
+ post: operations["createIssues"];
+ };
+ "/api/2/issue/createmeta/{projectIdOrKey}/issuetypes": {
+ /**
+ * @description Returns the metadata for issue types used for creating issues.
+ * Data will not be returned if the user does not have permission to create issues in that project.
+ */
+ get: operations["getCreateIssueMetaProjectIssueTypes"];
+ parameters: {
+ path: {
+ /** @description to get metadata for */
+ projectIdOrKey: string;
+ };
+ };
+ };
+ "/api/2/issue/createmeta/{projectIdOrKey}/issuetypes/{issueTypeId}": {
+ /**
+ * @description Returns the metadata for issue types used for creating issues.
+ * Data will not be returned if the user does not have permission to create issues in that project.
+ */
+ get: operations["getCreateIssueMetaFields"];
+ parameters: {
+ path: {
+ /** @description to get metadata for */
+ issueTypeId: string;
+ /** @description to get metadata for */
+ projectIdOrKey: string;
+ };
+ };
+ };
+ "/api/2/issue/picker": {
+ /**
+ * @description Returns suggested issues which match the auto-completion query for the user which executes this request. This REST
+ * method will check the user's history and the user's browsing context and select this issues, which match the query.
+ */
+ get: operations["getIssuePickerResource"];
+ };
+ "/api/2/issue/{issueIdOrKey}": {
+ /**
+ * @description Returns a full representation of the issue for the given issue key.
+ *
+ * An issue JSON consists of the issue key, a collection of fields,
+ * a link to the workflow transition sub-resource, and (optionally) the HTML rendered values of any fields that support it
+ * (e.g. if wiki syntax is enabled for the description or comments).
+ *
+ * The fields param (which can be specified multiple times) gives a comma-separated list of fields
+ * to include in the response. This can be used to retrieve a subset of fields.
+ * A particular field can be excluded by prefixing it with a minus.
+ *
+ * By default, all (*all) fields are returned in this get-issue resource. Note: the default is different
+ * when doing a jql search -- the default there is just navigable fields (*navigable).
+ *
+ * *all - include all fields*navigable - include just navigable fieldssummary,comment - include just the summary and comments-comment - include everything except comments (the default is *all for get-issue)*all,-comment - include everything except comments
+ *
+ * The {@code properties} param is similar to {@code fields} and specifies a comma-separated list of issue
+ * properties to include. Unlike {@code fields}, properties are not included by default. To include them all
+ * send {@code ?properties=*all}. You can also include only specified properties or exclude some properties
+ * with a minus (-) sign.
+ *
+ *
+ * - {@code *all} - include all properties
+ * - {@code *all, -prop1} - include all properties except {@code prop1}
+ * - {@code prop1, prop1} - include {@code prop1} and {@code prop2} properties
+ *
+ *
+ *
+ * Jira will attempt to identify the issue by the issueIdOrKey path parameter. This can be an issue id,
+ * or an issue key. If the issue cannot be found via an exact match, Jira will also look for the issue in a case-insensitive way, or
+ * by looking to see if the issue was moved. In either of these cases, the request will proceed as normal (a 302 or other redirect
+ * will not be returned). The issue key contained in the response will indicate the current value of issue's key.
+ *
+ * The expand param is used to include, hidden by default, parts of response. This can be used to include:
+ *
+ * renderedFields - field values in HTML formatnames - display name of each fieldschema - schema for each field which describes a type of the fieldtransitions - all possible transitions for the given issueoperations - all possibles operations which may be applied on issueeditmeta - information about how each field may be edited. It contains field's schema as well.changelog - history of all changes of the given issueversionedRepresentations -
+ * REST representations of all fields. Some field may contain more recent versions. RESET representations are numbered.
+ * The greatest number always represents the most recent version. It is recommended that the most recent version is used.
+ * version for these fields which provide a more recent REST representation.
+ * After including versionedRepresentations "fields" field become hidden.
+ */
+ get: operations["getIssue"];
+ /**
+ * @description Edits an issue from a JSON representation.
+ *
+ * The issue can either be updated by setting explicit the field value(s)
+ * or by using an operation to change the field value.
+ *
+ * The fields that can be updated, in either the fields parameter or the update parameter, can be determined
+ * using the /rest/api/2/issue/{issueIdOrKey}/editmeta resource.
+ * If a field is not configured to appear on the edit screen, then it will not be in the editmeta, and a field
+ * validation error will occur if it is submitted.
+ *
+ * Specifying a "field_id": field_value in the "fields" is a shorthand for a "set" operation in the "update" section.
+ * Field should appear either in "fields" or "update", not in both.
+ */
+ put: operations["editIssue"];
+ /**
+ * @description Delete an issue.
+ *
+ * If the issue has subtasks you must set the parameter deleteSubtasks=true to delete the issue.
+ * You cannot delete an issue without its subtasks also being deleted.
+ */
+ delete: operations["deleteIssue"];
+ parameters: {
+ path: {
+ /** @description the issue id or key to update (i.e. JRA-1330) */
+ issueIdOrKey: string;
+ };
+ };
+ };
+ "/api/2/issue/{issueIdOrKey}/archive": {
+ /** @description Archives an issue. */
+ put: operations["archiveIssue"];
+ parameters: {
+ path: {
+ /** @description Issue id or issue key */
+ issueIdOrKey: string;
+ };
+ };
+ };
+ "/api/2/issue/{issueIdOrKey}/assignee": {
+ /**
+ * @description Assigns an issue to a user.
+ * You can use this resource to assign issues when the user submitting the request has the assign permission but not the
+ * edit issue permission.
+ * If the name is "-1" automatic assignee is used. A null name will remove the assignee.
+ */
+ put: operations["assign"];
+ parameters: {
+ path: {
+ /** @description a String containing an issue key */
+ issueIdOrKey: string;
+ };
+ };
+ };
+ "/api/2/issue/{issueIdOrKey}/attachments": {
+ /**
+ * @description Add one or more attachments to an issue.
+ *
+ * This resource expects a multipart post. The media-type multipart/form-data is defined in RFC 1867. Most client
+ * libraries have classes that make dealing with multipart posts simple. For instance, in Java the Apache HTTP Components
+ * library provides a
+ * MultiPartEntity
+ * that makes it simple to submit a multipart POST.
+ *
+ * In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection
+ * on it. This means you must submit a header of X-Atlassian-Token: no-check with the request, otherwise it will be
+ * blocked.
+ *
+ * The name of the multipart/form-data parameter that contains attachments must be "file"
+ *
+ * A simple example to upload a file called "myfile.txt" to issue REST-123:
+ *
curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: no-check" -F "file=@myfile.txt" http://myhost/rest/api/2/issue/TEST-123/attachments
+ */
+ post: operations["addAttachment"];
+ parameters: {
+ path: {
+ /** @description the issue that you want to add the attachments to */
+ issueIdOrKey: string;
+ };
+ };
+ };
+ "/api/2/issue/{issueIdOrKey}/comment": {
+ /**
+ * @description Returns all comments for an issue.
+ *
+ * Results can be ordered by the "created" field which means the date a comment was added.
+ *
+ */
+ get: operations["getComments"];
+ /** @description Adds a new comment to an issue. */
+ post: operations["addComment"];
+ parameters: {
+ path: {
+ /** @description a string containing the issue id or key the comment will be added to */
+ issueIdOrKey: string;
+ };
+ };
+ };
+ "/api/2/issue/{issueIdOrKey}/comment/{id}": {
+ /** @description Returns a single comment. */
+ get: operations["getComment"];
+ /** @description Updates an existing comment using its JSON representation. */
+ put: operations["updateComment"];
+ /** @description Deletes an existing comment . */
+ delete: operations["deleteComment"];
+ parameters: {
+ path: {
+ /** @description of the issue the comment belongs to */
+ issueIdOrKey: string;
+ /** @description the ID of the comment to request */
+ id: string;
+ };
+ };
+ };
+ "/api/2/issue/{issueIdOrKey}/comment/{id}/pin": {
+ put: operations["setPinComment"];
+ parameters: {
+ path: {
+ issueIdOrKey: string;
+ id: string;
+ };
+ };
+ };
+ "/api/2/issue/{issueIdOrKey}/editmeta": {
+ /**
+ * @description Returns the meta data for editing an issue.
+ *
+ * The fields in the editmeta correspond to the fields in the edit screen for the issue.
+ * Fields not in the screen will not be in the editmeta.
+ */
+ get: operations["getEditIssueMeta"];
+ parameters: {
+ path: {
+ /** @description the issue whose edit meta data you want to view */
+ issueIdOrKey: string;
+ };
+ };
+ };
+ "/api/2/issue/{issueIdOrKey}/notify": {
+ /** @description Sends a notification (email) to the list or recipients defined in the request. */
+ post: operations["notify"];
+ parameters: {
+ path: {
+ /** @description a string containing the issue id or key the comment will be added to */
+ issueIdOrKey: string;
+ };
+ };
+ };
+ "/api/2/issue/{issueIdOrKey}/pinned-comments": {
+ /** @description Returns all pinned to the issue comments. */
+ get: operations["getPinnedComments"];
+ parameters: {
+ path: {
+ /** @description of the issue the comment belongs to */
+ issueIdOrKey: string;
+ };
+ };
+ };
+ "/api/2/issue/{issueIdOrKey}/properties": {
+ /** @description Returns the keys of all properties for the issue identified by the key or by the id. */
+ get: operations["getPropertiesKeys"];
+ parameters: {
+ path: {
+ /** @description the issue from which keys will be returned. */
+ issueIdOrKey: string;
+ };
+ };
+ };
+ "/api/2/issue/{issueIdOrKey}/properties/{propertyKey}": {
+ /**
+ * @description Returns the value of the property with a given key from the issue identified by the key or by the id. The user who retrieves
+ * the property is required to have permissions to read the issue.
+ */
+ get: operations["getProperty"];
+ /**
+ * @description Sets the value of the specified issue's property.
+ *
+ * You can use this resource to store a custom data against the issue identified by the key or by the id. The user
+ * who stores the data is required to have permissions to edit the issue.
+ *
+ */
+ put: operations["setProperty"];
+ /**
+ * @description Removes the property from the issue identified by the key or by the id. Ths user removing the property is required
+ * to have permissions to edit the issue.
+ */
+ delete: operations["deleteProperty"];
+ parameters: {
+ path: {
+ /** @description the issue from which keys will be returned. */
+ issueIdOrKey: string;
+ /** @description the key of the property to return. */
+ propertyKey: string;
+ };
+ };
+ };
+ "/api/2/issue/{issueIdOrKey}/remotelink": {
+ /** @description A REST sub-resource representing the remote issue links on the issue. */
+ get: operations["getRemoteIssueLinks"];
+ /**
+ * @description Creates or updates a remote issue link from a JSON representation. If a globalId is provided and a remote issue link
+ * exists with that globalId, the remote issue link is updated. Otherwise, the remote issue link is created.
+ */
+ post: operations["createOrUpdateRemoteIssueLink"];
+ /** @description Delete the remote issue link with the given global id on the issue. */
+ delete: operations["deleteRemoteIssueLinkByGlobalId"];
+ parameters: {
+ path: {
+ /** @description the issue to create the remote issue link for */
+ issueIdOrKey: string;
+ };
+ };
+ };
+ "/api/2/issue/{issueIdOrKey}/remotelink/{linkId}": {
+ /** @description Get the remote issue link with the given id on the issue. */
+ get: operations["getRemoteIssueLinkById"];
+ /** @description Updates a remote issue link from a JSON representation. Any fields not provided are set to null. */
+ put: operations["updateRemoteIssueLink"];
+ /** @description Delete the remote issue link with the given id on the issue. */
+ delete: operations["deleteRemoteIssueLinkById"];
+ parameters: {
+ path: {
+ /** @description the id of the remote issue link */
+ linkId: string;
+ /** @description the issue to create the remote issue link for */
+ issueIdOrKey: string;
+ };
+ };
+ };
+ "/api/2/issue/{issueIdOrKey}/restore": {
+ /** @description Restores an archived issue. */
+ put: operations["restoreIssue"];
+ parameters: {
+ path: {
+ /** @description Issue id or issue key */
+ issueIdOrKey: string;
+ };
+ };
+ };
+ "/api/2/issue/{issueIdOrKey}/subtask": {
+ /** @description Returns an issue's subtask list */
+ get: operations["getSubTasks"];
+ parameters: {
+ path: {
+ /** @description The parent issue's key or id */
+ issueIdOrKey: string;
+ };
+ };
+ };
+ "/api/2/issue/{issueIdOrKey}/subtask/move": {
+ get: operations["canMoveSubTask"];
+ /**
+ * @description Reorders an issue's subtasks by moving the subtask at index "from"
+ * to index "to".
+ */
+ post: operations["moveSubTasks"];
+ parameters: {
+ path: {
+ /** @description The parent issue's key or id */
+ issueIdOrKey: string;
+ };
+ };
+ };
+ "/api/2/issue/{issueIdOrKey}/transitions": {
+ /**
+ * @description Get a list of the transitions possible for this issue by the current user, along with fields that are required and their types.
+ *
+ * Fields will only be returned if expand=transitions.fields.
+ *
+ * The fields in the metadata correspond to the fields in the transition screen for that transition.
+ * Fields not in the screen will not be in the metadata.
+ */
+ get: operations["getTransitions"];
+ /**
+ * @description Perform a transition on an issue.
+ * When performing the transition you can update or set other issue fields.
+ *
+ * The fields that can be set on transtion, in either the fields parameter or the update parameter can be determined
+ * using the /rest/api/2/issue/{issueIdOrKey}/transitions?expand=transitions.fields resource.
+ * If a field is not configured to appear on the transition screen, then it will not be in the transition metadata, and a field
+ * validation error will occur if it is submitted.
+ *
+ * The updateHistory param adds the issues retrieved by this method to the current user's issue history,
+ * if set to true (by default, the issue history does not include issues retrieved via the REST API).
+ * You can view the issue history in the Jira application, via the Issues dropdown or by using the
+ * lastViewed JQL field in an issue search.
+ */
+ post: operations["doTransition"];
+ parameters: {
+ path: {
+ /** @description the issue you want to transition */
+ issueIdOrKey: string;
+ };
+ };
+ };
+ "/api/2/issue/{issueIdOrKey}/votes": {
+ /** @description A REST sub-resource representing the voters on the issue. */
+ get: operations["getVotes"];
+ /** @description Cast your vote in favour of an issue. */
+ post: operations["addVote"];
+ /** @description Remove your vote from an issue. (i.e. "unvote") */
+ delete: operations["removeVote"];
+ parameters: {
+ path: {
+ /** @description the issue to view voting information for */
+ issueIdOrKey: string;
+ };
+ };
+ };
+ "/api/2/issue/{issueIdOrKey}/watchers": {
+ /** @description Returns the list of watchers for the issue with the given key. */
+ get: operations["getIssueWatchers"];
+ /** @description Adds a user to an issue's watcher list. */
+ post: operations["addWatcher"];
+ /** @description Removes a user from an issue's watcher list. */
+ delete: operations["removeWatcher"];
+ parameters: {
+ path: {
+ /** @description a String containing an issue key. */
+ issueIdOrKey: string;
+ };
+ };
+ };
+ "/api/2/issue/{issueIdOrKey}/worklog": {
+ /**
+ * @description Returns all work logs for an issue.
+ * Note: Work logs won't be returned if the Log work field is hidden for the project.
+ */
+ get: operations["getIssueWorklog"];
+ /** @description Adds a new worklog entry to an issue. */
+ post: operations["addWorklog"];
+ parameters: {
+ path: {
+ /** @description a string containing the issue id or key the worklog will be added to */
+ issueIdOrKey: string;
+ };
+ };
+ };
+ "/api/2/issue/{issueIdOrKey}/worklog/{id}": {
+ /**
+ * @description Returns a specific worklog.
+ * Note: The work log won't be returned if the Log work field is hidden for the project.
+ */
+ get: operations["getWorklog"];
+ /**
+ * @description Updates an existing worklog entry.
+ *
Note that:
+ *
+ * - Fields possible for editing are: comment, visibility, started, timeSpent and timeSpentSeconds.
+ * - Either timeSpent or timeSpentSeconds can be set.
+ * - Fields which are not set will not be updated.
+ * - For a request to be valid, it has to have at least one field change.
+ *
+ */
+ put: operations["updateWorklog"];
+ /** @description Deletes an existing worklog entry. */
+ delete: operations["deleteWorklog"];
+ parameters: {
+ path: {
+ /** @description a string containing the issue id or key the worklog belongs to */
+ issueIdOrKey: string;
+ /** @description id of the worklog to be deleted */
+ id: string;
+ };
+ };
+ };
+ "/api/2/issueLink": {
+ /**
+ * @description Creates an issue link between two issues.
+ * The user requires the link issue permission for the issue which will be linked to another issue.
+ * The specified link type in the request is used to create the link and will create a link from the first issue
+ * to the second issue using the outward description. It also create a link from the second issue to the first issue using the
+ * inward description of the issue link type.
+ * It will add the supplied comment to the first issue. The comment can have a restriction who can view it.
+ * If group is specified, only users of this group can view this comment, if roleLevel is specified only users who have the specified role can view this comment.
+ * The user who creates the issue link needs to belong to the specified group or have the specified role.
+ */
+ post: operations["linkIssues"];
+ };
+ "/api/2/issueLink/{linkId}": {
+ /** @description Returns an issue link with the specified id. */
+ get: operations["getIssueLink"];
+ /**
+ * @description Deletes an issue link with the specified id.
+ * To be able to delete an issue link you must be able to view both issues and must have the link issue permission
+ * for at least one of the issues.
+ */
+ delete: operations["deleteIssueLink"];
+ parameters: {
+ path: {
+ /** @description the issue link id. */
+ linkId: string;
+ };
+ };
+ };
+ "/api/2/issueLinkType": {
+ /**
+ * @description Returns a list of available issue link types, if issue linking is enabled.
+ * Each issue link type has an id, a name and a label for the outward and inward link relationship.
+ */
+ get: operations["getIssueLinkTypes"];
+ /** @description Create a new issue link type. */
+ post: operations["createIssueLinkType"];
+ };
+ "/api/2/issueLinkType/{issueLinkTypeId}": {
+ /** @description Returns for a given issue link type id all information about this issue link type. */
+ get: operations["getIssueLinkType"];
+ /** @description Update the specified issue link type. */
+ put: operations["updateIssueLinkType"];
+ /** @description Delete the specified issue link type. */
+ delete: operations["deleteIssueLinkType"];
+ parameters: {
+ path: {
+ issueLinkTypeId: string;
+ };
+ };
+ };
+ "/api/2/issuesecurityschemes": {
+ /** @description Returns all issue security schemes that are defined. */
+ get: operations["getIssueSecuritySchemes"];
+ };
+ "/api/2/issuesecurityschemes/{id}": {
+ /** @description Returns the issue security scheme along with that are defined. */
+ get: operations["getIssueSecurityScheme"];
+ parameters: {
+ path: {
+ id: number;
+ };
+ };
+ };
+ "/api/2/issuetype": {
+ /** @description Returns a list of all issue types visible to the user */
+ get: operations["getIssueAllTypes"];
+ /**
+ * @description Creates an issue type from a JSON representation and adds the issue newly created issue type to the default issue
+ * type scheme.
+ */
+ post: operations["createIssueType"];
+ };
+ "/api/2/issuetype/page": {
+ /** @description Returns paginated list of filtered issue types */
+ get: operations["getPaginatedIssueTypes"];
+ };
+ "/api/2/issuetype/{id}": {
+ /** @description Returns a full representation of the issue type that has the given id. */
+ get: operations["getIssueType"];
+ /** @description Updates the specified issue type from a JSON representation. */
+ put: operations["updateIssueType"];
+ /**
+ * @description Deletes the specified issue type. If the issue type has any associated issues, these issues will be migrated to
+ * the alternative issue type specified in the parameter. You can determine the alternative issue types by calling
+ * the /rest/api/2/issuetype/{id}/alternatives resource.
+ */
+ delete: operations["deleteIssueType"];
+ parameters: {
+ path: {
+ /** @description a String containing an issue type id */
+ id: string;
+ };
+ };
+ };
+ "/api/2/issuetype/{id}/alternatives": {
+ /**
+ * @description Returns a list of all alternative issue types for the given issue type id. The list will contain these issues types, to which
+ * issues assigned to the given issue type can be migrated. The suitable alternatives are issue types which are assigned
+ * to the same workflow, the same field configuration and the same screen scheme.
+ */
+ get: operations["getAlternativeIssueTypes"];
+ parameters: {
+ path: {
+ id: string;
+ };
+ };
+ };
+ "/api/2/issuetype/{id}/avatar": {
+ /** @description Converts temporary avatar into a real avatar */
+ post: operations["createAvatarFromTemporary"];
+ parameters: {
+ path: {
+ /** @description the id of the issue type, which avatar is updated. */
+ id: string;
+ };
+ };
+ };
+ "/api/2/issuetype/{id}/avatar/temporary": {
+ /**
+ * @description Creates temporary avatar using multipart. The response is sent back as JSON stored in a textarea. This is because
+ * the client uses remote iframing to submit avatars using multipart. So we must send them a valid HTML page back from
+ * which the client parses the JSON from.
+ *
+ * Creating a temporary avatar is part of a 3-step process in uploading a new
+ * avatar for an issue type: upload, crop, confirm. This endpoint allows you to use a multipart upload
+ * instead of sending the image directly as the request body.
+ *
+ *
+ * You *must* use "avatar" as the name of the upload parameter:
+ *
+ *
+ * curl -c cookiejar.txt -X POST -u admin:admin -H "X-Atlassian-Token: no-check" \
+ * -F "avatar=@mynewavatar.png;type=image/png" \
+ * 'http://localhost:8090/jira/rest/api/2/issuetype/1/avatar/temporary'
+ *
+ */
+ post: operations["storeTemporaryAvatarUsingMultiPart"];
+ parameters: {
+ path: {
+ /** @description the id of the issue type, which avatar is updated. */
+ id: string;
+ };
+ };
+ };
+ "/api/2/issuetype/{issueTypeId}/properties": {
+ /** @description Returns the keys of all properties for the issue type identified by the id. */
+ get: operations["getPropertyKeys"];
+ parameters: {
+ path: {
+ /** @description the issue type from which the keys will be returned */
+ issueTypeId: string;
+ };
+ };
+ };
+ "/api/2/issuetype/{issueTypeId}/properties/{propertyKey}": {
+ /**
+ * @description Returns the value of the property with a given key from the issue type identified by the id. The user who retrieves
+ * the property is required to have permissions to view the issue type.
+ */
+ get: operations["getProperty"];
+ /**
+ * @description Sets the value of the specified issue type's property.
+ *
+ * You can use this resource to store a custom data against an issue type identified by the id. The user
+ * who stores the data is required to have permissions to edit an issue type.
+ *
+ */
+ put: operations["setProperty"];
+ /**
+ * @description Removes the property from the issue type identified by the id. Ths user removing the property is required
+ * to have permissions to edit the issue type.
+ */
+ delete: operations["deleteProperty"];
+ parameters: {
+ path: {
+ /** @description the issue type from which the keys will be returned */
+ issueTypeId: string;
+ /** @description the key of the property to return */
+ propertyKey: string;
+ };
+ };
+ };
+ "/api/2/issuetypescheme": {
+ /**
+ * @description Returns a list of all issue type schemes visible to the user (must be admin).
+ *
+ * All issue types associated with the scheme will only be returned if an additional query parameter is provided:
+ * expand=schemes.issueTypes.
+ *
+ *
+ * Similarly, the default issue type associated with the scheme (if one exists) will only be returned if
+ * additional an query parameter is provided: expand=schemes.defaultIssueType.
+ *
+ *
+ * Note that both query parameters can be used together: expand=schemes.issueTypes,schemes.defaultIssueType.
+ *
+ */
+ get: operations["getAllIssueTypeSchemes"];
+ /** @description Creates an issue type scheme from a JSON representation. (Admin required) */
+ post: operations["createIssueTypeScheme"];
+ };
+ "/api/2/issuetypescheme/{schemeId}": {
+ /** @description Returns a full representation of the issue type scheme that has the given id (must be admin). */
+ get: operations["getIssueTypeScheme"];
+ /** @description Updates the specified issue type scheme from a JSON representation. (Admin required) */
+ put: operations["updateIssueTypeScheme"];
+ /**
+ * @description Deletes the specified issue type scheme. Any projects associated with this IssueTypeScheme will be automatically
+ * associated with the global default IssueTypeScheme. (Admin required)
+ */
+ delete: operations["deleteIssueTypeScheme"];
+ parameters: {
+ path: {
+ /** @description the id of the issue type scheme to remove. */
+ schemeId: string;
+ };
+ };
+ };
+ "/api/2/issuetypescheme/{schemeId}/associations": {
+ /** @description For the specified issue type scheme, returns all of the associated projects. (Admin required) */
+ get: operations["getAssociatedProjects"];
+ /**
+ * @description Associates the given projects with the specified issue type scheme. Any existing project-associations the issue
+ * type scheme has will be overwritten. (Admin required)
+ */
+ put: operations["setProjectAssociationsForScheme"];
+ /** @description Adds additional projects to those already associated with the specified issue type scheme. (Admin required) */
+ post: operations["addProjectAssociationsToScheme"];
+ /**
+ * @description Removes all project associations for the specified issue type scheme. These projects revert to an association with
+ * the default/global issue type scheme.(Admin required)
+ */
+ delete: operations["removeAllProjectAssociations"];
+ parameters: {
+ path: {
+ /** @description the id of the issue type scheme whose project associations we're removing */
+ schemeId: string;
+ };
+ };
+ };
+ "/api/2/issuetypescheme/{schemeId}/associations/{projIdOrKey}": {
+ /**
+ * @description For the specified issue type scheme, removes the given project association . This project reverts to an association
+ * with the default/global issue type scheme.(Admin required)
+ */
+ delete: operations["removeProjectAssociation"];
+ parameters: {
+ path: {
+ /** @description the id or key of the project that is to be un-associated with the issue type scheme */
+ projIdOrKey: string;
+ /** @description the id of the issue type scheme whose project association we're removing */
+ schemeId: string;
+ };
+ };
+ };
+ "/api/2/jql/autocompletedata": {
+ /** @description Returns the auto complete data required for JQL searches. */
+ get: operations["getAutoComplete"];
+ };
+ "/api/2/jql/autocompletedata/suggestions": {
+ /** @description Returns auto complete suggestions for JQL search. */
+ get: operations["getFieldAutoCompleteForQueryString"];
+ };
+ "/api/2/licenseValidator": {
+ post: operations["validate"];
+ };
+ "/api/2/monitoring/app": {
+ get: operations["isAppMonitoringEnabled"];
+ post: operations["setAppMonitoringEnabled"];
+ };
+ "/api/2/monitoring/ipd": {
+ get: operations["isIpdMonitoringEnabled"];
+ post: operations["setAppMonitoringEnabled"];
+ };
+ "/api/2/monitoring/jmx/areMetricsExposed": {
+ get: operations["areMetricsExposed"];
+ };
+ "/api/2/monitoring/jmx/getAvailableMetrics": {
+ get: operations["getAvailableMetrics"];
+ };
+ "/api/2/monitoring/jmx/startExposing": {
+ post: operations["start"];
+ };
+ "/api/2/monitoring/jmx/stopExposing": {
+ post: operations["stop"];
+ };
+ "/api/2/mypermissions": {
+ /**
+ * @description Returns all permissions in the system and whether the currently logged in user has them. You can optionally provide a specific context to get permissions for
+ * (projectKey OR projectId OR issueKey OR issueId)
+ *
+ * - When no context supplied the project related permissions will return true if the user has that permission in ANY project
+ * - If a project context is provided, project related permissions will return true if the user has the permissions in the specified project.
+ * For permissions that are determined using issue data (e.g Current Assignee), true will be returned if the user meets the permission criteria in ANY issue in that project
+ * - If an issue context is provided, it will return whether or not the user has each permission in that specific issue
+ *
+ *
+ * NB: The above means that for issue-level permissions (EDIT_ISSUE for example), hasPermission may be true when no context is provided, or when a project context is provided,
+ * but may be false for any given (or all) issues. This would occur (for example) if Reporters were given the EDIT_ISSUE permission. This is because
+ * any user could be a reporter, except in the context of a concrete issue, where the reporter is known.
+ *
+ *
+ * Global permissions will still be returned for all scopes.
+ *
+ *
+ * Prior to version 6.4 this service returned project permissions with keys corresponding to com.atlassian.jira.security.Permissions.Permission constants.
+ * Since 6.4 those keys are considered deprecated and this service returns system project permission keys corresponding to constants defined in com.atlassian.jira.permission.ProjectPermissions.
+ * Permissions with legacy keys are still also returned for backwards compatibility, they are marked with an attribute deprecatedKey=true.
+ * The attribute is missing for project permissions with the current keys.
+ *
+ */
+ get: operations["getPermissions"];
+ };
+ "/api/2/mypreferences": {
+ /**
+ * @description Returns preference of the currently logged in user. Preference key must be provided as input parameter (key). The
+ * value is returned exactly as it is. If key parameter is not provided or wrong - status code 404. If value is
+ * found - status code 200.
+ */
+ get: operations["getPreference"];
+ /**
+ * @description Sets preference of the currently logged in user. Preference key must be provided as input parameters (key). Value
+ * must be provided as post body. If key or value parameter is not provided - status code 404. If preference is set
+ * - status code 204.
+ */
+ put: operations["setPreference"];
+ /**
+ * @description Removes preference of the currently logged in user. Preference key must be provided as input parameters (key). If
+ * key parameter is not provided or wrong - status code 404. If preference is unset - status code 204.
+ */
+ delete: operations["removePreference"];
+ };
+ "/api/2/myself": {
+ /** @description Returns currently logged user. This resource cannot be accessed anonymously. */
+ get: operations["getUser"];
+ /**
+ * @description Modify currently logged user. The "value" fields present will override the existing value.
+ * Fields skipped in request will not be changed. Only email and display name can be change that way.
+ * Requires user password.
+ */
+ put: operations["updateUser"];
+ };
+ "/api/2/myself/password": {
+ /** @description Modify caller password. */
+ put: operations["changeMyPassword"];
+ };
+ "/api/2/notificationscheme": {
+ /**
+ * @description Returns a paginated list of notification schemes. In order to access notification scheme, the calling user is
+ * required to have permissions to administer at least one project associated with the requested notification scheme. Each scheme contains
+ * a list of events and recipient configured to receive notifications for these events. Consumer should allow events without recipients to appear in response.
+ * The list is ordered by the scheme's name.
+ * Follow the documentation of /notificationscheme/{id} resource for all details about returned value.
+ */
+ get: operations["getNotificationSchemes"];
+ };
+ "/api/2/notificationscheme/{id}": {
+ /**
+ * @description Returns a full representation of the notification scheme for the given id. This resource will return a
+ * notification scheme containing a list of events and recipient configured to receive notifications for these events. Consumer
+ * should allow events without recipients to appear in response. User accessing
+ * the data is required to have permissions to administer at least one project associated with the requested notification scheme.
+ *
+ * Notification recipients can be:
+ *
+ * - current assignee - the value of the notificationType is CurrentAssignee
+ * - issue reporter - the value of the notificationType is Reporter
+ * - current user - the value of the notificationType is CurrentUser
+ * - project lead - the value of the notificationType is ProjectLead
+ * - component lead - the value of the notificationType is ComponentLead
+ * - all watchers - the value of the notification type is AllWatchers
+ * - configured user - the value of the notification type is User. Parameter will contain key of the user. Information about the user will be provided
+ * if user expand parameter is used.
+ * - configured group - the value of the notification type is Group. Parameter will contain name of the group. Information about the group will be provided
+ * if group expand parameter is used.
+ * - configured email address - the value of the notification type is EmailAddress, additionally information about the email will be provided.
+ * - users or users in groups in the configured custom fields - the value of the notification type is UserCustomField or GroupCustomField. Parameter
+ * will contain id of the custom field. Information about the field will be provided if field expand parameter is used.
+ * - configured project role - the value of the notification type is ProjectRole. Parameter will contain project role id. Information about the project role
+ * will be provided if projectRole expand parameter is used.
+ *
+ * Please see the example for reference.
+ *
+ * The events can be Jira system events or events configured by administrator. In case of the system events, data about theirs
+ * ids, names and descriptions is provided. In case of custom events, the template event is included as well.
+ */
+ get: operations["getNotificationScheme"];
+ parameters: {
+ path: {
+ /** @description an id of the notification scheme to retrieve */
+ id: number;
+ };
+ };
+ };
+ "/api/2/password/policy": {
+ /**
+ * @description Returns the list of requirements for the current password policy. For example, "The password must have at least 10 characters.",
+ * "The password must not be similar to the user's name or email address.", etc.
+ */
+ get: operations["getPasswordPolicy"];
+ };
+ "/api/2/password/policy/createUser": {
+ /**
+ * @description Returns a list of statements explaining why the password policy would disallow a proposed password for a new user.
+ *
+ * You can use this method to test the password policy validation. This could be done prior to an action
+ * where a new user and related password are created, using methods like the ones in
+ * UserService.
+ * For example, you could use this to validate a password in a create user form in the user interface, as the user enters it.
+ * The username and new password must be not empty to perform the validation.
+ * Note, this method will help you validate against the policy only. It won't check any other validations that might be performed
+ * when creating a new user, e.g. checking whether a user with the same name already exists.
+ *
+ */
+ post: operations["policyCheckCreateUser"];
+ };
+ "/api/2/password/policy/updateUser": {
+ /**
+ * @description Returns a list of statements explaining why the password policy would disallow a proposed new password for a user with an existing password.
+ *
+ * You can use this method to test the password policy validation. This could be done prior to an action where the password
+ * is actually updated, using methods like ChangePassword
+ * or ResetPassword.
+ * For example, you could use this to validate a password in a change password form in the user interface, as the user enters it.
+ * The user must exist and the username and new password must be not empty, to perform the validation.
+ * Note, this method will help you validate against the policy only. It won't check any other validations that might be performed
+ * when submitting a password change/reset request, e.g. verifying whether the old password is valid.
+ *
+ */
+ post: operations["policyCheckUpdateUser"];
+ };
+ "/api/2/permissions": {
+ /** @description Returns all permissions that are present in the Jira instance - Global, Project and the global ones added by plugins */
+ get: operations["getAllPermissions"];
+ };
+ "/api/2/permissionscheme": {
+ /**
+ * @description Returns a list of all permission schemes.
+ *
+ * By default only shortened beans are returned. If you want to include permissions of all the schemes,
+ * then specify the permissions expand parameter. Permissions will be included also if you specify
+ * any other expand parameter.
+ *
+ */
+ get: operations["getPermissionSchemes"];
+ /**
+ * @description Create a new permission scheme.
+ * This method can create schemes with a defined permission set, or without.
+ */
+ post: operations["createPermissionScheme"];
+ };
+ "/api/2/permissionscheme/{permissionSchemeId}/attribute/{attributeKey}": {
+ get: operations["getSchemeAttribute"];
+ parameters: {
+ path: {
+ /** @description permission scheme id */
+ permissionSchemeId: number;
+ /** @description permission scheme attribute key */
+ attributeKey: string;
+ };
+ };
+ };
+ "/api/2/permissionscheme/{permissionSchemeId}/attribute/{key}": {
+ /**
+ * @description Updates or inserts the attribute for a permission scheme specified by permission scheme id.
+ * The attribute consists of the key and the value. The value will be converted to Boolean using Boolean#valueOf.
+ */
+ put: operations["setSchemeAttribute"];
+ parameters: {
+ path: {
+ /** @description permission scheme id */
+ permissionSchemeId: number;
+ /** @description permission scheme attribute key */
+ key: string;
+ };
+ };
+ };
+ "/api/2/permissionscheme/{schemeId}": {
+ /** @description Returns a permission scheme identified by the given id. */
+ get: operations["getPermissionScheme"];
+ /**
+ * @description Updates a permission scheme.
+ *
+ * If the permissions list is present then it will be set in the permission scheme, which basically means it will overwrite any permission grants that
+ * existed in the permission scheme. Sending an empty list will remove all permission grants from the permission scheme.
+ *
+ *
+ * To update just the name and description, do not send permissions list at all.
+ *
+ *
+ * To add or remove a single permission grant instead of updating the whole list at once use the {schemeId}/permission/ resource.
+ *
+ */
+ put: operations["updatePermissionScheme"];
+ /** @description Deletes a permission scheme identified by the given id. */
+ delete: operations["deletePermissionScheme"];
+ parameters: {
+ path: {
+ schemeId: number;
+ };
+ };
+ };
+ "/api/2/permissionscheme/{schemeId}/permission": {
+ /** @description Returns all permission grants of the given permission scheme. */
+ get: operations["getPermissionSchemeGrants"];
+ /** @description Creates a permission grant in a permission scheme. */
+ post: operations["createPermissionGrant"];
+ parameters: {
+ path: {
+ schemeId: number;
+ };
+ };
+ };
+ "/api/2/permissionscheme/{schemeId}/permission/{permissionId}": {
+ /** @description Returns a permission grant identified by the given id. */
+ get: operations["getPermissionSchemeGrant"];
+ /** @description Deletes a permission grant from a permission scheme. */
+ delete: operations["deletePermissionSchemeEntity"];
+ parameters: {
+ path: {
+ permissionId: number;
+ schemeId: number;
+ };
+ };
+ };
+ "/api/2/priority": {
+ /** @description Returns a list of all issue priorities. */
+ get: operations["getPriorities"];
+ };
+ "/api/2/priority/page": {
+ /** @description Returns a list of all issue priorities. */
+ get: operations["getPriorities"];
+ };
+ "/api/2/priority/{id}": {
+ /** @description Returns an issue priority. */
+ get: operations["getPriority"];
+ parameters: {
+ path: {
+ /** @description a String containing the priority id */
+ id: string;
+ };
+ };
+ };
+ "/api/2/priorityschemes": {
+ /**
+ * @description Returns all priority schemes.
+ *
+ * All project keys associated with the priority scheme will only be returned if additional query parameter is provided expand=schemes.projectKeys.
+ */
+ get: operations["getPrioritySchemes"];
+ /** @description Creates new priority scheme. */
+ post: operations["createPriorityScheme"];
+ };
+ "/api/2/priorityschemes/{schemeId}": {
+ /**
+ * @description Gets a full representation of a priority scheme in JSON format.
+ *
+ * All project keys associated with the priority scheme will only be returned if additional query parameter is provided expand=projectKeys.
+ */
+ get: operations["getPriorityScheme"];
+ /**
+ * @description Updates a priority scheme.
+ * Update will be rejected if issue migration would be needed as a result of scheme update.
+ * Priority scheme update with migration is possible from the UI.
+ *
+ * All project keys associated with the priority scheme will only be returned if additional query parameter is provided expand=projectKeys.
+ */
+ put: operations["updatePriorityScheme"];
+ /**
+ * @description Deletes a priority scheme. All projects using deleted scheme will use default priority scheme afterwards.
+ *
+ * Default priority scheme can't be deleted.
+ */
+ delete: operations["deletePriorityScheme"];
+ parameters: {
+ path: {
+ /** @description id of priority scheme to get */
+ schemeId: number;
+ };
+ };
+ };
+ "/api/2/project": {
+ /**
+ * @description Returns all projects which are visible for the currently logged in user. If no user is logged in, it returns the
+ * list of projects that are visible when using anonymous access.
+ */
+ get: operations["getAllProjects"];
+ /** @description Creates a new project. */
+ post: operations["createProject"];
+ };
+ "/api/2/project/type": {
+ /**
+ * @description Returns all the project types defined on the Jira instance, not taking into account whether
+ * the license to use those project types is valid or not.
+ */
+ get: operations["getAllProjectTypes"];
+ };
+ "/api/2/project/type/{projectTypeKey}": {
+ /** @description Returns the project type with the given key. */
+ get: operations["getProjectTypeByKey"];
+ parameters: {
+ path: {
+ projectTypeKey: string;
+ };
+ };
+ };
+ "/api/2/project/type/{projectTypeKey}/accessible": {
+ /**
+ * @description Returns the project type with the given key, if it is accessible to the logged in user.
+ * This takes into account whether the user is licensed on the Application that defines the project type.
+ */
+ get: operations["getAccessibleProjectTypeByKey"];
+ parameters: {
+ path: {
+ projectTypeKey: string;
+ };
+ };
+ };
+ "/api/2/project/{projectIdOrKey}": {
+ /**
+ * @description Contains a full representation of a project in JSON format.
+ *
+ * All project keys associated with the project will only be returned if expand=projectKeys.
+ *
+ */
+ get: operations["getProject"];
+ /**
+ * @description Updates a project.
+ *
+ * Only non null values sent in JSON will be updated in the project.
+ *
+ * Values available for the assigneeType field are: "PROJECT_LEAD" and "UNASSIGNED".
+ */
+ put: operations["updateProject"];
+ /** @description Deletes a project. */
+ delete: operations["deleteProject"];
+ parameters: {
+ path: {
+ /** @description the project id or project key */
+ projectIdOrKey: string;
+ };
+ };
+ };
+ "/api/2/project/{projectIdOrKey}/archive": {
+ /** @description Archives a project. */
+ put: operations["archiveProject"];
+ parameters: {
+ path: {
+ /** @description Project id or project key */
+ projectIdOrKey: string;
+ };
+ };
+ };
+ "/api/2/project/{projectIdOrKey}/avatar": {
+ /**
+ * @description Updates an avatar for a project. This is step 3/3 of changing an avatar for a project:
+ *
+ *
+ * - Upload (store temporary avatar)
+ * - Crop (create avatar from temporary)
+ * - Update (update project avatar)
+ *
+ */
+ put: operations["updateProjectAvatar"];
+ /**
+ * @description Converts the temporary avatar into the final one. This is step 2/3 of changing an avatar for a project:
+ *
+ *
+ * - Upload (store temporary avatar)
+ * - Crop (create avatar from temporary)
+ * - Update (update project avatar)
+ *
+ */
+ post: operations["createAvatarFromTemporary"];
+ parameters: {
+ path: {
+ /** @description project id or project key */
+ projectIdOrKey: string;
+ };
+ };
+ };
+ "/api/2/project/{projectIdOrKey}/avatar/temporary": {
+ /**
+ * @description Creates temporary avatar using multipart. The response is sent back as JSON stored in a textarea. This is because
+ * the client uses remote iframing to submit avatars using multipart. So we must send them a valid HTML page back from
+ * which the client parses the JSON.
+ */
+ post: operations["storeTemporaryAvatarUsingMultiPart"];
+ parameters: {
+ path: {
+ /** @description Project id or project key */
+ projectIdOrKey: string;
+ };
+ };
+ };
+ "/api/2/project/{projectIdOrKey}/avatar/{id}": {
+ /** @description Deletes avatar */
+ delete: operations["deleteAvatar"];
+ parameters: {
+ path: {
+ /** @description Project id or project key */
+ projectIdOrKey: string;
+ /** @description database id for avatar */
+ id: number;
+ };
+ };
+ };
+ "/api/2/project/{projectIdOrKey}/avatars": {
+ /**
+ * @description Returns all avatars which are visible for the currently logged in user. The avatars are grouped into
+ * system and custom.
+ */
+ get: operations["getAllAvatars"];
+ parameters: {
+ path: {
+ /** @description project id or project key */
+ projectIdOrKey: string;
+ };
+ };
+ };
+ "/api/2/project/{projectIdOrKey}/components": {
+ /** @description Contains a full representation of a the specified project's components. */
+ get: operations["getProjectComponents"];
+ parameters: {
+ path: {
+ /** @description the project id or project key */
+ projectIdOrKey: string;
+ };
+ };
+ };
+ "/api/2/project/{projectIdOrKey}/properties": {
+ /** @description Returns the keys of all properties for the project identified by the key or by the id. */
+ get: operations["getPropertiesKeys"];
+ parameters: {
+ path: {
+ /** @description the project from which keys will be returned. */
+ projectIdOrKey: string;
+ };
+ };
+ };
+ "/api/2/project/{projectIdOrKey}/properties/{propertyKey}": {
+ /**
+ * @description Returns the value of the property with a given key from the project identified by the key or by the id. The user who retrieves
+ * the property is required to have permissions to read the project.
+ */
+ get: operations["getProperty"];
+ /**
+ * @description Sets the value of the specified project's property.
+ *
+ * You can use this resource to store a custom data against the project identified by the key or by the id. The user
+ * who stores the data is required to have permissions to administer the project.
+ *
+ */
+ put: operations["setProperty"];
+ /**
+ * @description Removes the property from the project identified by the key or by the id. Ths user removing the property is required
+ * to have permissions to administer the project.
+ */
+ delete: operations["deleteProperty"];
+ parameters: {
+ path: {
+ /** @description the project from which keys will be returned. */
+ projectIdOrKey: string;
+ /** @description the key of the property to return. */
+ propertyKey: string;
+ };
+ };
+ };
+ "/api/2/project/{projectIdOrKey}/restore": {
+ /**
+ * @description Restore an archived project.
+ * In case of success restored project should be re-indexed.
+ */
+ put: operations["restoreProject"];
+ parameters: {
+ path: {
+ /** @description Project id or project key */
+ projectIdOrKey: string;
+ };
+ };
+ };
+ "/api/2/project/{projectIdOrKey}/role": {
+ /** @description Returns all roles in the given project Id or key, with links to full details on each role. */
+ get: operations["getProjectRoles"];
+ parameters: {
+ path: {
+ /** @description the project id or project key */
+ projectIdOrKey: string;
+ };
+ };
+ };
+ "/api/2/project/{projectIdOrKey}/role/{id}": {
+ /** @description Returns the details for a given project role in a project. */
+ get: operations["getProjectRole"];
+ /**
+ * @description Updates a project role to include the specified actors (users or groups). Can be also used to clear roles to not include any users or groups.
+ *
+ * For user actors, their usernames should be used.
+ */
+ put: operations["setActors"];
+ /**
+ * @description Adds an actor (user or group) to a project role.
+ *
+ * For user actors, their usernames should be used.
+ */
+ post: operations["addActorUsers"];
+ /**
+ * @description Deletes actors (users or groups) from a project role.
+ *
+ *
+ * - Delete a user from the role:
/rest/api/2/project/{projectIdOrKey}/role/{roleId}?user={username}
+ * - Delete a group from the role:
/rest/api/2/project/{projectIdOrKey}/role/{roleId}?group={groupname}
+ *
+ */
+ delete: operations["deleteActor"];
+ parameters: {
+ path: {
+ /** @description the project id or project key */
+ projectIdOrKey: string;
+ /** @description the project role id */
+ id: number;
+ };
+ };
+ };
+ "/api/2/project/{projectIdOrKey}/statuses": {
+ /** @description Get all issue types with valid status values for a project */
+ get: operations["getAllStatuses"];
+ parameters: {
+ path: {
+ /** @description Project id or project key */
+ projectIdOrKey: string;
+ };
+ };
+ };
+ "/api/2/project/{projectIdOrKey}/type/{newProjectTypeKey}": {
+ /** @description Updates the type of a project. */
+ put: operations["updateProjectType"];
+ parameters: {
+ path: {
+ /** @description identity of the project to update */
+ projectIdOrKey: string;
+ /** @description The key of the new project type */
+ newProjectTypeKey: string;
+ };
+ };
+ };
+ "/api/2/project/{projectIdOrKey}/version": {
+ /**
+ * @description Returns all versions for the specified project. Results are paginated.
+ *
+ * Results can be ordered by the following fields:
+ *
+ * - sequence
+ * - name
+ * - startDate
+ * - releaseDate
+ *
+ *
+ */
+ get: operations["getProjectVersionsPaginated"];
+ parameters: {
+ path: {
+ /** @description the project id or project key */
+ projectIdOrKey: string;
+ };
+ };
+ };
+ "/api/2/project/{projectIdOrKey}/versions": {
+ /** @description Contains a full representation of a the specified project's versions. */
+ get: operations["getProjectVersions"];
+ parameters: {
+ path: {
+ /** @description the project id or project key */
+ projectIdOrKey: string;
+ };
+ };
+ };
+ "/api/2/project/{projectKeyOrId}/issuesecuritylevelscheme": {
+ /** @description Returns the issue security scheme for project. */
+ get: operations["getIssueSecurityScheme"];
+ parameters: {
+ path: {
+ projectKeyOrId: string;
+ };
+ };
+ };
+ "/api/2/project/{projectKeyOrId}/notificationscheme": {
+ /**
+ * @description Gets a notification scheme associated with the project.
+ * Follow the documentation of /notificationscheme/{id} resource for all details about returned value.
+ */
+ get: operations["getNotificationScheme"];
+ parameters: {
+ path: {
+ /** @description key or id of the project */
+ projectKeyOrId: string;
+ };
+ };
+ };
+ "/api/2/project/{projectKeyOrId}/permissionscheme": {
+ /** @description Gets a permission scheme assigned with a project. */
+ get: operations["getAssignedPermissionScheme"];
+ /** @description Assigns a permission scheme with a project. */
+ put: operations["assignPermissionScheme"];
+ parameters: {
+ path: {
+ /** @description key or id of the project */
+ projectKeyOrId: string;
+ };
+ };
+ };
+ "/api/2/project/{projectKeyOrId}/priorityscheme": {
+ /**
+ * @description Gets a full representation of a priority scheme in JSON format used by specified project.
+ * User must be global administrator or project administrator.
+ *
+ * All project keys associated with the priority scheme will only be returned if additional query parameter is provided expand=projectKeys.
+ */
+ get: operations["getAssignedPriorityScheme"];
+ /**
+ * @description Assigns project with priority scheme.
+ * Priority scheme assign with migration is possible from the UI.
+ *
+ * Operation will fail if migration is needed as a result of operation eg. there are issues with priorities invalid in the destination scheme.
+ *
+ * All project keys associated with the priority scheme will only be returned if additional query parameter is provided expand=projectKeys.
+ */
+ put: operations["assignPriorityScheme"];
+ parameters: {
+ path: {
+ /** @description key or id of the project */
+ projectKeyOrId: string;
+ };
+ };
+ };
+ "/api/2/project/{projectKeyOrId}/priorityscheme/{schemeId}": {
+ /**
+ * @description Unassigns project from priority scheme.
+ *
+ * Operation will fail for defualt priority scheme, project is not found or project is not associated with provided priority scheme.
+ *
+ * All project keys associated with the priority scheme will only be returned if additional query parameter is provided expand=projectKeys.
+ */
+ delete: operations["unassignPriorityScheme"];
+ parameters: {
+ path: {
+ /** @description key or id of the project */
+ projectKeyOrId: string;
+ /** @description object that contains an id of the scheme */
+ schemeId: number;
+ };
+ };
+ };
+ "/api/2/project/{projectKeyOrId}/securitylevel": {
+ /**
+ * @description Returns all security levels for the project that the current logged in user has access to.
+ * If the user does not have the Set Issue Security permission, the list will be empty.
+ */
+ get: operations["getSecurityLevelsForProject"];
+ parameters: {
+ path: {
+ /** @description - key or id of project to list the security levels for */
+ projectKeyOrId: string;
+ };
+ };
+ };
+ "/api/2/project/{projectKeyOrId}/workflowscheme": {
+ /** @description Returns the workflow scheme that is associated with requested project. */
+ get: operations["getWorkflowSchemeForProject"];
+ parameters: {
+ path: {
+ /** @description the key or id of the project. */
+ projectKeyOrId: string;
+ };
+ };
+ };
+ "/api/2/projectCategory": {
+ /** @description Returns all project categories */
+ get: operations["getAllProjectCategories"];
+ /** @description Create a project category via POST. */
+ post: operations["createProjectCategory"];
+ };
+ "/api/2/projectCategory/{id}": {
+ /** @description Contains a representation of a project category in JSON format. */
+ get: operations["getProjectCategoryById"];
+ /**
+ * @description Modify a project category via PUT. Any fields present in the PUT will override existing values. As a convenience, if a field
+ * is not present, it is silently ignored.
+ */
+ put: operations["updateProjectCategory"];
+ /** @description Delete a project category. */
+ delete: operations["removeProjectCategory"];
+ parameters: {
+ path: {
+ id: number;
+ };
+ };
+ };
+ "/api/2/projects/picker": {
+ /**
+ * @description Returns a list of projects visible to the user where project name and/or key is matching the given query.
+ *
+ * Passing an empty (or whitespace only) query will match no projects. The project matches will
+ * contain a field with the query highlighted.
+ *
+ * The number of projects returned can be controlled by passing a value for "maxResults", but a hard limit of no
+ * more than 100 projects is enforced. The projects are wrapped in a single response object that contains
+ * a header for use in the picker, specifically Showing X of Y matching projects and the total number
+ * of matches for the query.
+ */
+ get: operations["searchForProjects"];
+ };
+ "/api/2/projectvalidate/key": {
+ /** @description Validates a project key. */
+ get: operations["getProject"];
+ };
+ "/api/2/reindex": {
+ /**
+ * @description Returns information on the system reindexes. If a reindex is currently taking place then information about this reindex is returned.
+ * If there is no active index task, then returns information about the latest reindex task run, otherwise returns a 404
+ * indicating that no reindex has taken place.
+ */
+ get: operations["getReindexInfo"];
+ /** @description Kicks off a reindex. Need Admin permissions to perform this reindex. */
+ post: operations["reindex"];
+ };
+ "/api/2/reindex/issue": {
+ /**
+ * @description Reindexes one or more individual issues. Indexing is performed synchronously - the call returns when indexing of
+ * the issues has completed or a failure occurs.
+ *
+ * Use either explicitly specified issue IDs or a JQL query to select issues to reindex.
+ */
+ post: operations["reindexIssues"];
+ };
+ "/api/2/reindex/progress": {
+ /**
+ * @description Returns information on the system reindexes. If a reindex is currently taking place then information about this reindex is returned.
+ * If there is no active index task, then returns information about the latest reindex task run, otherwise returns a 404
+ * indicating that no reindex has taken place.
+ */
+ get: operations["getReindexProgress"];
+ };
+ "/api/2/reindex/request": {
+ /**
+ * @description Executes any pending reindex requests. Returns a JSON array containing the IDs of the reindex requests
+ * that are being processed. Execution is asynchronous - progress of the returned tasks can be monitored through
+ * other REST calls.
+ */
+ post: operations["processRequests"];
+ };
+ "/api/2/reindex/request/bulk": {
+ /**
+ * @description Retrieves the progress of a multiple reindex requests. Only reindex requests that actually exist will be returned
+ * in the results.
+ */
+ get: operations["getProgressBulk"];
+ };
+ "/api/2/reindex/request/{requestId}": {
+ /** @description Retrieves the progress of a single reindex request. */
+ get: operations["getProgress"];
+ parameters: {
+ path: {
+ /** @description the reindex request ID. */
+ requestId: number;
+ };
+ };
+ };
+ "/api/2/resolution": {
+ /** @description Returns a list of all resolutions. */
+ get: operations["getResolutions"];
+ };
+ "/api/2/resolution/page": {
+ /** @description Returns paginated list of filtered resolutions */
+ get: operations["getPaginatedResolutions"];
+ };
+ "/api/2/resolution/{id}": {
+ /** @description Returns a resolution. */
+ get: operations["getResolution"];
+ parameters: {
+ path: {
+ /** @description a String containing the resolution id */
+ id: string;
+ };
+ };
+ };
+ "/api/2/role": {
+ /** @description Get all the ProjectRoles available in Jira. Currently this list is global. */
+ get: operations["getProjectRoles"];
+ /**
+ * @description Creates a new ProjectRole to be available in Jira.
+ * The created role does not have any default actors assigned.
+ */
+ post: operations["createProjectRole"];
+ };
+ "/api/2/role/{id}": {
+ /** @description Get a specific ProjectRole available in Jira. */
+ get: operations["getProjectRolesById"];
+ /** @description Fully updates a roles. Both name and description must be given. */
+ put: operations["fullyUpdateProjectRole"];
+ /** @description Partially updates a roles name or description. */
+ post: operations["partialUpdateProjectRole"];
+ /** @description Deletes a role. May return 403 in the future */
+ delete: operations["deleteProjectRole"];
+ parameters: {
+ path: {
+ id: number;
+ };
+ };
+ };
+ "/api/2/role/{id}/actors": {
+ /** @description Gets default actors for the given role. */
+ get: operations["getProjectRoleActorsForRole"];
+ /** @description Adds default actors to the given role. The request data should contain a list of usernames or a list of groups to add. */
+ post: operations["addProjectRoleActorsToRole"];
+ /** @description Removes default actor from the given role. */
+ delete: operations["deleteProjectRoleActorsFromRole"];
+ parameters: {
+ path: {
+ /** @description the role id to remove the actors from */
+ id: number;
+ };
+ };
+ };
+ "/api/2/screens": {
+ /** @description Gets available field screens */
+ get: operations["getAllScreens"];
+ };
+ "/api/2/screens/addToDefault/{fieldId}": {
+ /** @description Adds field or custom field to the default tab */
+ post: operations["addFieldToDefaultScreen"];
+ parameters: {
+ path: {
+ /** @description id of field / custom field */
+ fieldId: string;
+ };
+ };
+ };
+ "/api/2/screens/{screenId}/availableFields": {
+ /** @description Gets available fields for screen. i.e ones that haven't already been added. */
+ get: operations["getFieldsToAdd"];
+ parameters: {
+ path: {
+ /** @description id of screen */
+ screenId: number;
+ };
+ };
+ };
+ "/api/2/screens/{screenId}/tabs": {
+ /** @description Returns a list of all tabs for the given screen */
+ get: operations["getAllTabs"];
+ /** @description Creates tab for given screen */
+ post: operations["addTab"];
+ parameters: {
+ path: {
+ /** @description id of screen */
+ screenId: number;
+ };
+ };
+ };
+ "/api/2/screens/{screenId}/tabs/{tabId}": {
+ /** @description Renames tab on given screen */
+ put: operations["renameTab"];
+ /** @description Deletes tab to give screen */
+ delete: operations["deleteTab"];
+ parameters: {
+ path: {
+ /** @description id of screen */
+ screenId: number;
+ /** @description id of tab */
+ tabId: number;
+ };
+ };
+ };
+ "/api/2/screens/{screenId}/tabs/{tabId}/fields": {
+ /** @description Gets all fields for a given tab */
+ get: operations["getAllFields"];
+ /** @description Adds field to the given tab. */
+ post: operations["addField"];
+ parameters: {
+ path: {
+ /** @description id of screen */
+ screenId: number;
+ /** @description id of tab */
+ tabId: number;
+ };
+ };
+ };
+ "/api/2/screens/{screenId}/tabs/{tabId}/fields/{id}": {
+ /** @description Removes field from given tab */
+ delete: operations["removeField"];
+ parameters: {
+ path: {
+ /** @description id of screen */
+ screenId: number;
+ /** @description id of tab */
+ tabId: number;
+ id: string;
+ };
+ };
+ };
+ "/api/2/screens/{screenId}/tabs/{tabId}/fields/{id}/move": {
+ /** @description Moves field on the given tab */
+ post: operations["moveField"];
+ parameters: {
+ path: {
+ /** @description id of screen */
+ screenId: number;
+ /** @description id of tab */
+ tabId: number;
+ id: string;
+ };
+ };
+ };
+ "/api/2/screens/{screenId}/tabs/{tabId}/fields/{id}/updateShowWhenEmptyIndicator/{newValue}": {
+ /** @description Update 'showWhenEmptyIndicator' for given field on screen */
+ put: operations["updateShowWhenEmptyIndicator"];
+ parameters: {
+ path: {
+ /** @description id of screen */
+ screenId: number;
+ /** @description id of tab */
+ tabId: number;
+ /** @description new value of 'showWhenEmptyIndicator' */
+ newValue: boolean;
+ /** @description id of field */
+ id: string;
+ };
+ };
+ };
+ "/api/2/screens/{screenId}/tabs/{tabId}/move/{pos}": {
+ /** @description Moves tab position */
+ post: operations["moveTab"];
+ parameters: {
+ path: {
+ /** @description id of screen */
+ screenId: number;
+ /** @description id of tab */
+ tabId: number;
+ /** @description position of tab */
+ pos: number;
+ };
+ };
+ };
+ "/api/2/search": {
+ /**
+ * @description Searches for issues using JQL.
+ *
+ * Sorting
+ * the jql parameter is a full JQL
+ * expression, and includes an ORDER BY clause.
+ *
+ *
+ * The fields param (which can be specified multiple times) gives a comma-separated list of fields
+ * to include in the response. This can be used to retrieve a subset of fields.
+ * A particular field can be excluded by prefixing it with a minus.
+ *
+ * By default, only navigable (*navigable) fields are returned in this search resource. Note: the default is different
+ * in the get-issue resource -- the default there all fields (*all).
+ *
+ * *all - include all fields*navigable - include just navigable fieldssummary,comment - include just the summary and comments-description - include navigable fields except the description (the default is *navigable for search)*all,-comment - include everything except comments
+ *
+ *
+ * GET vs POST:
+ * If the JQL query is too large to be encoded as a query param you should instead
+ * POST to this resource.
+ *
+ *
+ * Expanding Issues in the Search Result:
+ * It is possible to expand the issues returned by directly specifying the expansion on the expand parameter passed
+ * in to this resources.
+ *
+ *
+ * For instance, to expand the "changelog" for all the issues on the search result, it is neccesary to
+ * specify "changelog" as one of the values to expand.
+ *
+ */
+ get: operations["search"];
+ /** @description Performs a search using JQL. */
+ post: operations["searchUsingSearchRequest"];
+ };
+ "/api/2/securitylevel/{id}": {
+ /** @description Returns a full representation of the security level that has the given id. */
+ get: operations["getIssuesecuritylevel"];
+ parameters: {
+ path: {
+ /** @description a String containing an issue security level id */
+ id: string;
+ };
+ };
+ };
+ "/api/2/serverInfo": {
+ /** @description Returns general information about the current Jira server. */
+ get: operations["getServerInfo"];
+ };
+ "/api/2/settings/baseUrl": {
+ /** @description Sets the base URL that is configured for this Jira instance. */
+ put: operations["setBaseURL"];
+ };
+ "/api/2/settings/columns": {
+ /** @description Returns the default system columns for issue navigator. Admin permission will be required. */
+ get: operations["getIssueNavigatorDefaultColumns"];
+ /** @description Sets the default system columns for issue navigator. Admin permission will be required. */
+ put: operations["setIssueNavigatorDefaultColumns"];
+ };
+ "/api/2/status": {
+ /** @description Returns a list of all statuses */
+ get: operations["getStatuses"];
+ };
+ "/api/2/status/page": {
+ /** @description Returns paginated list of filtered statuses */
+ get: operations["getPaginatedStatuses"];
+ };
+ "/api/2/status/{idOrName}": {
+ /** @description Returns a full representation of the Status having the given id or name. */
+ get: operations["getStatus"];
+ parameters: {
+ path: {
+ /** @description a numeric Status id or a status name */
+ idOrName: string;
+ };
+ };
+ };
+ "/api/2/statuscategory": {
+ /** @description Returns a list of all status categories */
+ get: operations["getStatusCategories"];
+ };
+ "/api/2/statuscategory/{idOrKey}": {
+ /** @description Returns a full representation of the StatusCategory having the given id or key */
+ get: operations["getStatusCategory"];
+ parameters: {
+ path: {
+ /** @description a numeric StatusCategory id or a status category key */
+ idOrKey: string;
+ };
+ };
+ };
+ "/api/2/terminology/entries": {
+ /** @description Returns the list of all defined names for the default words "epic" and "sprint". */
+ get: operations["getAllTerminologyEntries"];
+ /**
+ * @description Change epic/sprint names from {"originalName"} to {"newName"}. The {"newName"} will be displayed in Jira instead of {"originalName"}.
+ *
+ * {"originalName"} must be equal to "epic" or "sprint".
+ * There can be only one entry per unique {"originalName"}.
+ *
+ * {"newName"} can only consist of alphanumeric characters and spaces e.g. {"newName": "iteration number 2"}.
+ *
+ * {"newName"} must be between 1 to 100 characters.
+ * It can't use the already defined {"newName"} values or restricted JQL words .
+ *
+ * To reset {"newName"} to the default value, enter the {"originalName"} value as the value for {"newName"}. For example, if you want to return to {"originalName": "sprint"}, enter {"newName": "sprint"}.
+ */
+ post: operations["setTerminologyEntries"];
+ };
+ "/api/2/terminology/entries/{originalName}": {
+ /** @description Returns epic or sprint name as specified in the {originalName} path param. */
+ get: operations["getTerminologyEntry"];
+ parameters: {
+ path: {
+ originalName: string;
+ };
+ };
+ };
+ "/api/2/universal_avatar/type/{type}/owner/{owningObjectId}": {
+ get: operations["getAvatars"];
+ parameters: {
+ path: {
+ type: string;
+ owningObjectId: string;
+ };
+ };
+ };
+ "/api/2/universal_avatar/type/{type}/owner/{owningObjectId}/avatar": {
+ post: operations["createAvatarFromTemporary"];
+ parameters: {
+ path: {
+ type: string;
+ owningObjectId: string;
+ };
+ };
+ };
+ "/api/2/universal_avatar/type/{type}/owner/{owningObjectId}/avatar/{id}": {
+ /** @description Deletes avatar */
+ delete: operations["deleteAvatar"];
+ parameters: {
+ path: {
+ /** @description database id for avatar */
+ id: number;
+ /** @description Project id or project key */
+ type: string;
+ owningObjectId: string;
+ };
+ };
+ };
+ "/api/2/universal_avatar/type/{type}/owner/{owningObjectId}/temp": {
+ post: operations["storeTemporaryAvatarUsingMultiPart"];
+ parameters: {
+ path: {
+ type: string;
+ owningObjectId: string;
+ };
+ };
+ };
+ "/api/2/upgrade": {
+ /**
+ * @description Returns the result of the last upgrade task.
+ *
+ * Returns {@link javax.ws.rs.core.Response#seeOther(java.net.URI)} if still running.
+ */
+ get: operations["getUpgradeResult"];
+ /** @description Runs any pending delayed upgrade tasks. Need Admin permissions to do this. */
+ post: operations["runUpgradesNow"];
+ };
+ "/api/2/user": {
+ /** @description Returns a user. This resource cannot be accessed anonymously. */
+ get: operations["getUser"];
+ /**
+ * @description Modify user. The "value" fields present will override the existing value.
+ * Fields skipped in request will not be changed.
+ */
+ put: operations["updateUser"];
+ /**
+ * @description Create user. By default created user will not be notified with email.
+ * If password field is not set then password will be randomly generated.
+ */
+ post: operations["createUser"];
+ /**
+ * @description Removes user and its references (like project roles associations, watches, history).
+ *
+ *
+ * Note: user references will not be removed if multiple User Directories are used and there is a user with
+ * the same name existing in another directory (shadowing user).
+ */
+ delete: operations["removeUser"];
+ };
+ "/api/2/user/a11y/personal-settings": {
+ /**
+ * @description Returns available accessibility personal settings along with `enabled` property
+ * that indicates the currently logged-in user preference.
+ */
+ get: operations["getA11yPersonalSettings"];
+ };
+ "/api/2/user/anonymization": {
+ /** @description Validates user anonymization process. */
+ get: operations["validateUserAnonymization"];
+ /** @description Schedules a user anonymization process. Requires system admin permission. */
+ post: operations["scheduleUserAnonymization"];
+ };
+ "/api/2/user/anonymization/progress": {
+ /** @description Returns information about a user anonymization operation progress. */
+ get: operations["getProgress"];
+ };
+ "/api/2/user/anonymization/rerun": {
+ /** @description Validates user anonymization re-run process. */
+ get: operations["validateUserAnonymizationRerun"];
+ /** @description Schedules a user anonymization process. Requires system admin permission. */
+ post: operations["scheduleUserAnonymizationRerun"];
+ };
+ "/api/2/user/anonymization/unlock": {
+ /**
+ * @description Removes stale user anonymization task, for scenarios when the node that was executing it is no longer alive.
+ *
+ * Use it only after making sure that the parent node of the task is actually down, and not just having
+ * connectivity issues.
+ */
+ delete: operations["unlockAnonymization"];
+ };
+ "/api/2/user/application": {
+ /** @description Add user to given application. Admin permission will be required to perform this operation. */
+ post: operations["addUserToApplication"];
+ /** @description Remove user from given application. Admin permission will be required to perform this operation. */
+ delete: operations["removeUserFromApplication"];
+ };
+ "/api/2/user/assignable/multiProjectSearch": {
+ /** @description Returns a list of users that match the search string and can be assigned issues for all the given projects. */
+ get: operations["findBulkAssignableUsers"];
+ };
+ "/api/2/user/assignable/search": {
+ /**
+ * @description Returns a list of users that match the search string. This resource cannot be accessed anonymously.
+ * Please note that this resource should be called with an issue key when a list of assignable users is retrieved
+ * for editing. For create only a project key should be supplied. The list of assignable users may be incorrect
+ * if it's called with the project key for editing.
+ */
+ get: operations["findAssignableUsers"];
+ };
+ "/api/2/user/avatar": {
+ put: operations["updateUserAvatar"];
+ /** @description Converts temporary avatar into a real avatar */
+ post: operations["createAvatarFromTemporary"];
+ };
+ "/api/2/user/avatar/temporary": {
+ /**
+ * @description Creates temporary avatar using multipart. The response is sent back as JSON stored in a textarea. This is because
+ * the client uses remote iframing to submit avatars using multipart. So we must send them a valid HTML page back from
+ * which the client parses the JSON from.
+ *
+ * Creating a temporary avatar is part of a 3-step process in uploading a new
+ * avatar for a user: upload, crop, confirm. This endpoint allows you to use a multipart upload
+ * instead of sending the image directly as the request body.
+ *
+ *
+ * You *must* use "avatar" as the name of the upload parameter:
+ *
+ *
+ * curl -c cookiejar.txt -X POST -u admin:admin -H "X-Atlassian-Token: no-check" \
+ * -F "avatar=@mynewavatar.png;type=image/png" \
+ * 'http://localhost:8090/jira/rest/api/2/user/avatar/temporary?username=admin'
+ *
+ */
+ post: operations["storeTemporaryAvatarUsingMultiPart"];
+ };
+ "/api/2/user/avatar/{id}": {
+ /** @description Deletes avatar */
+ delete: operations["deleteAvatar"];
+ parameters: {
+ path: {
+ /** @description database id for avatar */
+ id: number;
+ };
+ };
+ };
+ "/api/2/user/avatars": {
+ /** @description Returns all avatars which are visible for the currently logged in user. */
+ get: operations["getAllAvatars"];
+ };
+ "/api/2/user/columns": {
+ /**
+ * @description Returns the default columns for the given user. Admin permission will be required to get columns for a user
+ * other than the currently logged in user.
+ */
+ get: operations["defaultColumns"];
+ /**
+ * @description Sets the default columns for the given user. Admin permission will be required to get columns for a user
+ * other than the currently logged in user.
+ */
+ put: operations["setColumns"];
+ /**
+ * @description Reset the default columns for the given user to the system default. Admin permission will be required to get
+ * columns for a user other than the currently logged in user.
+ */
+ delete: operations["resetColumns"];
+ };
+ "/api/2/user/duplicated/count": {
+ /**
+ * @description Returns the number of users whose accounts are duplicated.
+ * Duplicated means that the user has an account in more than one directory
+ * and either more than one account is active or the only active account does not belong to the directory
+ * with the highest priority.
+ * The data returned by this endpoint is cached for 10 minutes and the cache is flushed when any User Directory
+ * is added, removed, enabled, disabled, or synchronized.
+ * A System Administrator can also flush the cache manually.
+ * Related JAC ticket: https://jira.atlassian.com/browse/JRASERVER-68797
+ */
+ get: operations["getDuplicatedUsersCount"];
+ };
+ "/api/2/user/duplicated/list": {
+ /**
+ * @description Returns duplicated users mapped to their directories with an indication if their accounts are active or not.
+ * Duplicated means that the user has an account in more than one directory and either more than one account is active
+ * or the only active account does not belong to the directory with the highest priority.
+ * The data returned by this endpoint is cached for 10 minutes and the cache is flushed when any User Directory
+ * is added, removed, enabled, disabled, or synchronized.
+ * A System Administrator can also flush the cache manually.
+ * Related JAC ticket: https://jira.atlassian.com/browse/JRASERVER-68797
+ */
+ get: operations["getDuplicatedUsersMapping"];
+ };
+ "/api/2/user/password": {
+ /** @description Modify user password. */
+ put: operations["changeUserPassword"];
+ };
+ "/api/2/user/permission/search": {
+ /**
+ * @description Returns a list of active users that match the search string and have all specified permissions for the project or issue.
+ * This resource can be accessed by users with ADMINISTER_PROJECT permission for the project or global ADMIN or SYSADMIN rights.
+ * This endpoint can cause serious performance issues and will be removed in Jira 9.0.
+ */
+ get: operations["findUsersWithAllPermissions"];
+ };
+ "/api/2/user/picker": {
+ /** @description Returns a list of users matching query with highlighting. */
+ get: operations["findUsersForPicker"];
+ };
+ "/api/2/user/properties/": {
+ /** @description Returns the keys of all properties for the user identified by the key or by the id. */
+ get: operations["getPropertiesKeys"];
+ };
+ "/api/2/user/properties/{propertyKey}": {
+ /**
+ * @description Returns the value of the property with a given key from the user identified by the key or by the id. The user who retrieves
+ * the property is required to have permissions to read the user.
+ */
+ get: operations["getProperty"];
+ /**
+ * @description Sets the value of the specified user's property.
+ *
+ * You can use this resource to store a custom data against the user identified by the key or by the id. The user
+ * who stores the data is required to have permissions to administer the user.
+ *
+ */
+ put: operations["setProperty"];
+ /**
+ * @description Removes the property from the user identified by the key or by the id. Ths user removing the property is required
+ * to have permissions to administer the user.
+ */
+ delete: operations["deleteProperty"];
+ parameters: {
+ path: {
+ propertyKey: string;
+ };
+ };
+ };
+ "/api/2/user/search": {
+ /** @description Returns a list of users that match the search string. This resource cannot be accessed anonymously. */
+ get: operations["findUsers"];
+ };
+ "/api/2/user/session/{username}": {
+ delete: operations["deleteSession"];
+ parameters: {
+ path: {
+ username: string;
+ };
+ };
+ };
+ "/api/2/user/viewissue/search": {
+ /**
+ * @description Returns a list of active users that match the search string. This resource cannot be accessed anonymously
+ * and requires the Browse Users global permission.
+ * Given an issue key this resource will provide a list of users that match the search string and have
+ * the browse issue permission for the issue provided.
+ */
+ get: operations["findUsersWithBrowsePermission"];
+ };
+ "/api/2/version": {
+ /** @description Retrieve paginated collection of versions matching given query optionally filtered by given project IDs. */
+ get: operations["getPaginatedVersions"];
+ /** @description Create a version via POST. */
+ post: operations["createVersion"];
+ };
+ "/api/2/version/remotelink": {
+ /** @description Returns the remote version links for a given global ID. */
+ get: operations["getRemoteVersionLinks"];
+ };
+ "/api/2/version/{id}": {
+ /** @description Returns a project version. */
+ get: operations["getVersion"];
+ /**
+ * @description Modify a version via PUT. Any fields present in the PUT will override existing values. As a convenience, if a field
+ * is not present, it is silently ignored.
+ */
+ put: operations["updateVersion"];
+ /** @description Delete a project version. */
+ delete: operations["delete"];
+ parameters: {
+ path: {
+ /** @description The version to delete */
+ id: string;
+ };
+ };
+ };
+ "/api/2/version/{id}/mergeto/{moveIssuesTo}": {
+ /** @description Merge versions */
+ put: operations["merge"];
+ parameters: {
+ path: {
+ /**
+ * @description The version to set fixVersion to on issues where the deleted version is the fix version,
+ * If null then the fixVersion is removed.
+ */
+ moveIssuesTo: string;
+ /** @description The version that will be merged to version {@code moveIssuesTo} and removed */
+ id: string;
+ };
+ };
+ };
+ "/api/2/version/{id}/move": {
+ /**
+ * @description Modify a version's sequence within a project.
+ *
+ * The move version bean has 2 alternative field value pairs:
+ *
+ * - position
- An absolute position, which may have a value of 'First', 'Last', 'Earlier' or 'Later'
+ * - after
- A version to place this version after. The value should be the self link of another version
+ *
+ */
+ post: operations["moveVersion"];
+ parameters: {
+ path: {
+ /** @description a String containing the version id */
+ id: string;
+ };
+ };
+ };
+ "/api/2/version/{id}/relatedIssueCounts": {
+ /** @description Returns a bean containing the number of fixed in and affected issues for the given version. */
+ get: operations["getVersionRelatedIssues"];
+ parameters: {
+ path: {
+ /** @description a String containing the version id */
+ id: string;
+ };
+ };
+ };
+ "/api/2/version/{id}/removeAndSwap": {
+ /** @description Delete a project version. */
+ post: operations["delete"];
+ parameters: {
+ path: {
+ /** @description The version to delete */
+ id: string;
+ };
+ };
+ };
+ "/api/2/version/{id}/unresolvedIssueCount": {
+ /** @description Returns the number of unresolved issues for the given version */
+ get: operations["getVersionUnresolvedIssues"];
+ parameters: {
+ path: {
+ /** @description a String containing the version id */
+ id: string;
+ };
+ };
+ };
+ "/api/2/version/{versionId}/remotelink": {
+ /** @description Returns the remote version links associated with the given version ID. */
+ get: operations["getRemoteVersionLinksByVersionId"];
+ /**
+ * @description Create a remote version link via POST. The link's global ID will be taken from the
+ * JSON payload if provided; otherwise, it will be generated.
+ */
+ post: operations["createOrUpdateRemoteVersionLink"];
+ /** @description Delete all remote version links for a given version ID. */
+ delete: operations["deleteRemoteVersionLinksByVersionId"];
+ parameters: {
+ path: {
+ /** @description The version for which to delete ALL existing remote version links */
+ versionId: string;
+ };
+ };
+ };
+ "/api/2/version/{versionId}/remotelink/{globalId}": {
+ /** @description A REST sub-resource representing a remote version link */
+ get: operations["getRemoteVersionLink"];
+ /**
+ * @description Create a remote version link via POST. The link's global ID will be taken from the
+ * JSON payload if provided; otherwise, it will be generated.
+ */
+ post: operations["createOrUpdateRemoteVersionLink"];
+ /** @description Delete a specific remote version link with the given version ID and global ID. */
+ delete: operations["deleteRemoteVersionLink"];
+ parameters: {
+ path: {
+ /** @description The version ID of the remote link */
+ versionId: string;
+ /** @description The global ID of the remote link */
+ globalId: string;
+ };
+ };
+ };
+ "/api/2/workflow": {
+ /**
+ * @description Returns all workflows. The “lastModifiedDate” is returned in Jira Complete Date/Time Format (dd/MMM/yy h:mm by default),
+ * but can also be returned as a relative date.
+ */
+ get: operations["getAllWorkflows"];
+ };
+ "/api/2/workflow/api/2/transitions/{id}/properties": {
+ /** @description Return the property or properties associated with a transition. */
+ get: operations["getProperties"];
+ /**
+ * @description Update/add new property to a transition. Trying to update a property that does
+ * not exist will result in a new property being added.
+ */
+ put: operations["updateProperty"];
+ /**
+ * @description Add a new property to a transition. Trying to add a property that already
+ * exists will fail.
+ */
+ post: operations["createProperty"];
+ /**
+ * @description Delete a property from the passed transition on the passed workflow. It is not an error to delete a property that
+ * does not exist.
+ */
+ delete: operations["deleteProperty"];
+ parameters: {
+ path: {
+ /** @description the ID of the transition within the workflow. */
+ id: number;
+ };
+ };
+ };
+ "/api/2/workflowscheme": {
+ /**
+ * @description Create a new workflow scheme.
+ *
+ * The body contains a representation of the new scheme. Values not passed are assumed to be set to their defaults.
+ */
+ post: operations["createScheme"];
+ };
+ "/api/2/workflowscheme/{id}": {
+ /** @description Returns the requested workflow scheme to the caller. */
+ get: operations["getById"];
+ /**
+ * @description Update the passed workflow scheme.
+ *
+ * The body of the request is a representation of the workflow scheme. Values not passed are assumed to indicate
+ * no change for that field.
+ *
+ * The passed representation can have its updateDraftIfNeeded flag set to true to indicate that the draft
+ * should be created and/or updated when the actual scheme cannot be edited (e.g. when the scheme is being used by
+ * a project). Values not appearing the body will not be touched.
+ */
+ put: operations["update"];
+ /** @description Delete the passed workflow scheme. */
+ delete: operations["deleteScheme"];
+ parameters: {
+ path: {
+ /** @description the id of the scheme. */
+ id: number;
+ };
+ };
+ };
+ "/api/2/workflowscheme/{id}/createdraft": {
+ /** @description Create a draft for the passed scheme. The draft will be a copy of the state of the parent. */
+ post: operations["createDraftForParent"];
+ parameters: {
+ path: {
+ /** @description the id of the parent scheme. */
+ id: number;
+ };
+ };
+ };
+ "/api/2/workflowscheme/{id}/default": {
+ /** @description Return the default workflow from the passed workflow scheme. */
+ get: operations["getDefault"];
+ /**
+ * @description Set the default workflow for the passed workflow scheme.
+ *
+ * The passed representation can have its
+ * updateDraftIfNeeded flag set to true to indicate that the draft should be created/updated when the actual scheme
+ * cannot be edited.
+ */
+ put: operations["updateDefault"];
+ /** @description Remove the default workflow from the passed workflow scheme. */
+ delete: operations["deleteDefault"];
+ parameters: {
+ path: {
+ /** @description the id of the scheme. */
+ id: number;
+ };
+ };
+ };
+ "/api/2/workflowscheme/{id}/draft": {
+ /** @description Returns the requested draft workflow scheme to the caller. */
+ get: operations["getDraftById"];
+ /**
+ * @description Update a draft workflow scheme. The draft will created if necessary.
+ *
+ * The body is a representation of the workflow scheme. Values not passed are assumed to indicate no change for that field.
+ */
+ put: operations["updateDraft"];
+ /** @description Delete the passed draft workflow scheme. */
+ delete: operations["deleteDraftById"];
+ parameters: {
+ path: {
+ /** @description the id of the parent scheme. */
+ id: number;
+ };
+ };
+ };
+ "/api/2/workflowscheme/{id}/draft/default": {
+ /** @description Return the default workflow from the passed draft workflow scheme to the caller. */
+ get: operations["getDraftDefault"];
+ /** @description Set the default workflow for the passed draft workflow scheme. */
+ put: operations["updateDraftDefault"];
+ /** @description Remove the default workflow from the passed draft workflow scheme. */
+ delete: operations["deleteDraftDefault"];
+ parameters: {
+ path: {
+ /** @description the id of the parent scheme. */
+ id: number;
+ };
+ };
+ };
+ "/api/2/workflowscheme/{id}/draft/issuetype/{issueType}": {
+ /** @description Returns the issue type mapping for the passed draft workflow scheme. */
+ get: operations["getDraftIssueType"];
+ /**
+ * @description Set the issue type mapping for the passed draft scheme.
+ *
+ * The passed representation can have its updateDraftIfNeeded flag set to true to indicate that
+ * the draft should be created/updated when the actual scheme cannot be edited.
+ */
+ put: operations["setDraftIssueType"];
+ /** @description Remove the specified issue type mapping from the draft scheme. */
+ delete: operations["deleteDraftIssueType"];
+ parameters: {
+ path: {
+ /** @description the issue type being set. */
+ issueType: string;
+ /** @description the id of the parent scheme. */
+ id: number;
+ };
+ };
+ };
+ "/api/2/workflowscheme/{id}/draft/workflow": {
+ /** @description Returns the draft workflow mappings or requested mapping to the caller. */
+ get: operations["getDraftWorkflow"];
+ /**
+ * @description Update the draft scheme to include the passed mapping.
+ *
+ * The body is a representation of the workflow mapping.
+ * Values not passed are assumed to indicate no change for that field.
+ */
+ put: operations["updateDraftWorkflowMapping"];
+ /** @description Delete the passed workflow from the draft workflow scheme. */
+ delete: operations["deleteDraftWorkflowMapping"];
+ parameters: {
+ path: {
+ /** @description the id of the parent scheme. */
+ id: number;
+ };
+ };
+ };
+ "/api/2/workflowscheme/{id}/issuetype/{issueType}": {
+ /** @description Returns the issue type mapping for the passed workflow scheme. */
+ get: operations["getIssueType"];
+ /**
+ * @description Set the issue type mapping for the passed scheme.
+ *
+ * The passed representation can have its updateDraftIfNeeded flag set to true to indicate that
+ * the draft should be created/updated when the actual scheme cannot be edited.
+ */
+ put: operations["setIssueType"];
+ /** @description Remove the specified issue type mapping from the scheme. */
+ delete: operations["deleteIssueType"];
+ parameters: {
+ path: {
+ /** @description the issue type being set. */
+ issueType: string;
+ /** @description the id of the scheme. */
+ id: number;
+ };
+ };
+ };
+ "/api/2/workflowscheme/{id}/workflow": {
+ /** @description Returns the workflow mappings or requested mapping to the caller for the passed scheme. */
+ get: operations["getWorkflow"];
+ /**
+ * @description Update the scheme to include the passed mapping.
+ *
+ * The body is a representation of the workflow mapping.
+ * Values not passed are assumed to indicate no change for that field.
+ *
+ * The passed representation can have its updateDraftIfNeeded flag set to true to indicate that the draft
+ * should be created/updated when the actual scheme cannot be edited.
+ */
+ put: operations["updateWorkflowMapping"];
+ /** @description Delete the passed workflow from the workflow scheme. */
+ delete: operations["deleteWorkflowMapping"];
+ parameters: {
+ path: {
+ /** @description the id of the scheme. */
+ id: number;
+ };
+ };
+ };
+ "/api/2/worklog/deleted": {
+ /**
+ * @description Returns worklogs id and delete time of worklogs that was deleted since given time.
+ * The returns set of worklogs is limited to 1000 elements.
+ * This API will not return worklogs deleted during last minute.
+ */
+ get: operations["getIdsOfWorklogsDeletedSince"];
+ };
+ "/api/2/worklog/list": {
+ /**
+ * @description Returns worklogs for given worklog ids. Only worklogs to which the calling user has permissions, will be included in the result.
+ * The returns set of worklogs is limited to 1000 elements.
+ */
+ post: operations["getWorklogsForIds"];
+ };
+ "/api/2/worklog/updated": {
+ /**
+ * @description Returns worklogs id and update time of worklogs that was updated since given time.
+ * The returns set of worklogs is limited to 1000 elements.
+ * This API will not return worklogs updated during last minute.
+ */
+ get: operations["getIdsOfWorklogsModifiedSince"];
+ };
+ "/auth/1/session": {
+ /**
+ * @description Returns information about the currently authenticated user's session. If the caller is not authenticated they
+ * will get a 401 Unauthorized status code.
+ */
+ get: operations["currentUser"];
+ /**
+ * @description Creates a new session for a user in Jira. Once a session has been successfully created it can be used to access
+ * any of Jira's remote APIs and also the web UI by passing the appropriate HTTP Cookie header.
+ *
+ * Note that it is generally preferrable to use HTTP BASIC authentication with the REST API. However, this resource
+ * may be used to mimic the behaviour of Jira's log-in page (e.g. to display log-in errors to a user).
+ */
+ post: operations["login"];
+ /** @description Logs the current user out of Jira, destroying the existing session, if any. */
+ delete: operations["logout"];
+ };
+ "/auth/1/websudo": {
+ /** @description This method invalidates the any current WebSudo session. */
+ delete: operations["release"];
+ };
+}
+
+export type webhooks = Record;
+
+export type components = Record;
+
+export type $defs = Record;
+
+export type external = Record;
+
+export interface operations {
+ /**
+ * @description Returns the value of the property with a given key from the user identified by the key or by the id. The user who retrieves
+ * the property is required to have permissions to read the user.
+ */
+ getProperty: {
+ parameters: {
+ query?: {
+ /** @description key of the user whose property is to be returned */
+ userKey?: string;
+ /** @description username of the user whose property is to be returned */
+ username?: string;
+ };
+ path: {
+ propertyKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns the properties that are displayed on the "General Configuration > Advanced Settings" page. */
+ getAdvancedSettings: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Modify an application property via PUT. The "value" field present in the PUT will override the existing value. */
+ setPropertyViaRestfulTable: {
+ parameters: {
+ path: {
+ id: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns all ApplicationRoles in the system. Will also return an ETag header containing a version hash of the
+ * collection of ApplicationRoles.
+ */
+ getAll: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Updates the ApplicationRoles with the passed data if the version hash is the same as the server.
+ * Only the groups and default groups setting of the role may be updated. Requests to change the key
+ * or the name of the role will be silently ignored. It is acceptable to pass only the roles that are updated
+ * as roles that are present in the server but not in data to update with, will not be deleted.
+ */
+ putBulk: {
+ parameters: {
+ header?: {
+ "If-Match"?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns the ApplicationRole with passed key if it exists. */
+ get: {
+ parameters: {
+ path: {
+ /** @description the key of the role to update. */
+ key: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Updates the ApplicationRole with the passed data. Only the groups and default groups setting of the
+ * role may be updated. Requests to change the key or the name of the role will be silently ignored.
+ *
+ * Optional: If versionHash is passed through the If-Match header the request will be rejected if not the
+ * same as server
+ */
+ put: {
+ parameters: {
+ header?: {
+ /** @description the hash of the version to update. Optional Param */
+ "If-Match"?: string;
+ };
+ path: {
+ /** @description the key of the role to update. */
+ key: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns the meta information for an attachments, specifically if they are enabled and the maximum upload size
+ * allowed.
+ */
+ getAttachmentMeta: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns the meta-data for an attachment, including the URI of the actual attached file. */
+ getAttachment: {
+ parameters: {
+ path: {
+ /** @description id of the attachment to remove */
+ id: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Remove an attachment from an issue. */
+ removeAttachment: {
+ parameters: {
+ path: {
+ /** @description id of the attachment to remove */
+ id: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Tries to expand an attachment. Output is human-readable and subject to change. */
+ expandForHumans: {
+ parameters: {
+ path: {
+ /** @description the id of the attachment to expand. */
+ id: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Tries to expand an attachment. Output is raw and should be backwards-compatible through the course of time. */
+ expandForMachines: {
+ parameters: {
+ path: {
+ /** @description the id of the attachment to expand. */
+ id: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns auditing records filtered using provided parameters */
+ getRecords: {
+ parameters: {
+ query?: {
+ /** @description - the number of record from which search starts */
+ offset?: number;
+ /** @description - maximum number of returned results (if is limit is <= 0 or > 1000, it will be set do default value: 1000) */
+ limit?: number;
+ /** @description - text query; each record that will be returned must contain the provided text in one of its fields */
+ filter?: string;
+ /**
+ * @description - timestamp in past; 'from' must be less or equal 'to', otherwise the result set will be empty
+ * only records that where created in the same moment or after the 'from' timestamp will be provided in response
+ */
+ from?: string;
+ /**
+ * @description - timestamp in past; 'from' must be less or equal 'to', otherwise the result set will be empty
+ * only records that where created in the same moment or earlier than the 'to' timestamp will be provided in response
+ */
+ to?: string;
+ /** @description - list of project ids to look for */
+ projectIds?: string;
+ /** @description - list of user ids to look for */
+ userIds?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Store a record in audit log */
+ addRecord: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns all system avatars of the given type. */
+ getAllSystemAvatars: {
+ parameters: {
+ path: {
+ /** @description the avatar type */
+ type: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Creates temporary avatar */
+ storeTemporaryAvatar: {
+ parameters: {
+ query?: {
+ /** @description name of file being uploaded */
+ filename?: string;
+ /** @description size of file */
+ size?: number;
+ };
+ path: {
+ /** @description the avatar type */
+ type: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Converts temporary avatar into a real avatar */
+ createAvatarFromTemporary: {
+ parameters: {
+ query?: {
+ /** @description username */
+ username?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description request current index from node (the request is processed asynchronously) */
+ requestCurrentIndexFromNode: {
+ parameters: {
+ path: {
+ nodeId: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Delete the node from the cluster if state of node is OFFLINE. */
+ deleteNode: {
+ parameters: {
+ path: {
+ nodeId: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Change the node's state to offline if the node is reporting as active, but is not alive.
+ * Don't use this method as an equivalent of running ./stop-jira.sh. This method doesn't shut down
+ * a node, but only changes its state, so that other nodes don't communicate with it.
+ */
+ changeNodeStateToOffline: {
+ parameters: {
+ path: {
+ nodeId: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ getAllNodes: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ approveUpgrade: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ cancelUpgrade: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ acknowledgeErrors: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ setReadyToUpgrade: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ getState: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns the keys of all properties for the user identified by the key or by the id. */
+ getPropertiesKeys: {
+ parameters: {
+ query?: {
+ /** @description key of the user whose properties are to be returned */
+ userKey?: string;
+ /** @description username of the user whose properties are to be returned */
+ username?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Sets the value of the specified user's property.
+ *
+ * You can use this resource to store a custom data against the user identified by the key or by the id. The user
+ * who stores the data is required to have permissions to administer the user.
+ *
+ */
+ setProperty: {
+ parameters: {
+ query?: {
+ /** @description key of the user whose property is to be set */
+ userKey?: string;
+ /** @description username of the user whose property is to be set */
+ username?: string;
+ };
+ path: {
+ propertyKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Delete a property from the passed transition on the passed workflow. It is not an error to delete a property that
+ * does not exist.
+ */
+ deleteProperty: {
+ parameters: {
+ query?: {
+ /** @description the name of the property to add. */
+ key?: string;
+ /** @description the name of the workflow to use. */
+ workflowName?: string;
+ /** @description the type of workflow to use. Can either be "live" or "draft". */
+ workflowMode?: string;
+ };
+ path: {
+ /** @description the ID of the transition within the workflow. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Create a component via POST. */
+ createComponent: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns paginated list of filtered active components */
+ getPaginatedComponents: {
+ parameters: {
+ query?: {
+ /** @description the index of the first components to return */
+ startAt?: number;
+ /** @description the maximum number of components to return */
+ maxResults?: number;
+ /** @description the string that components names will be matched with */
+ query?: string;
+ /** @description the set of project ids to filter components */
+ projectIds?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns a project component. */
+ getComponent: {
+ parameters: {
+ path: {
+ /** @description The component to delete. */
+ id: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Modify a component via PUT. Any fields present in the PUT will override existing values. As a convenience, if a field
+ * is not present, it is silently ignored.
+ *
+ * If leadUserName is an empty string ("") the component lead will be removed.
+ */
+ updateComponent: {
+ parameters: {
+ path: {
+ /** @description The component to delete. */
+ id: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Delete a project version. */
+ delete: {
+ parameters: {
+ path: {
+ /** @description The version to delete */
+ id: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns counts of issues related to this component. */
+ getComponentRelatedIssues: {
+ parameters: {
+ path: {
+ /** @description a String containing the component id */
+ id: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns the information if the optional features in Jira are enabled or disabled. If the time tracking is enabled,
+ * it also returns the detailed information about time tracking configuration.
+ */
+ getConfiguration: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns a full representation of the Custom Field Option that has the given id. */
+ getCustomFieldOption: {
+ parameters: {
+ path: {
+ /** @description a String containing an Custom Field Option id */
+ id: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ getCustomFields: {
+ parameters: {
+ query?: {
+ startAt?: number;
+ maxResults?: number;
+ search?: string;
+ projectIds?: string;
+ screenIds?: string;
+ types?: string;
+ sortOrder?: string;
+ sortColumn?: string;
+ lastValueUpdate?: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ bulkDeleteCustomFields: {
+ parameters: {
+ query?: {
+ ids?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns custom field's options defined in a given context composed of projects and issue types.
+ *
+ * If the projects and issue types match more than one context or the context for such a combination does not exist then no options are returned.
+ */
+ getCustomFieldOptions: {
+ parameters: {
+ query?: {
+ /** @description a list of projects in a context. */
+ projectIds?: string;
+ /** @description a list of issue types in a context. */
+ issueTypeIds?: string;
+ /** @description a string used to filter options. An option matches the query if any word in option's name starts with the given query. */
+ query?: string;
+ /** @description a limit of results. */
+ maxResults?: number;
+ /** @description the page of options to return. */
+ page?: number;
+ };
+ path: {
+ /** @description id of a custom field. */
+ customFieldId: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns a list of all dashboards, optionally filtering them. */
+ list: {
+ parameters: {
+ query?: {
+ /**
+ * @description an optional filter that is applied to the list of dashboards. Valid values include
+ * "favourite" for returning only favourite dashboards, and "my" for returning
+ * dashboards that are owned by the calling user.
+ */
+ filter?: string;
+ /**
+ * @description the index of the first dashboard to return (0-based). must be 0 or a multiple of
+ * maxResults
+ */
+ startAt?: number;
+ /**
+ * @description a hint as to the maximum number of dashboards to return in each call. Note that the
+ * Jira server reserves the right to impose a maxResults limit that is lower than the value that a
+ * client provides, dues to lack of resources or any other condition. When this happens, your results will be
+ * truncated. Callers should always check the returned maxResults to determine the value that is
+ * effectively being used.
+ */
+ maxResults?: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns a single dashboard. */
+ getDashboard: {
+ parameters: {
+ path: {
+ /** @description the dashboard id */
+ id: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Creates a zip file containing email templates at local home and returns the file. */
+ downloadEmailTemplates: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Extracts given zip file to temporary templates folder. If the folder already exists it will replace it's content */
+ uploadEmailTemplates: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Replaces the current email templates pack with previously uploaded one, if exists. */
+ applyEmailTemplates: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Replaces the current email templates pack with default templates, which are copied over from Jira binaries. */
+ revertEmailTemplatesToDefault: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns a list of root templates mapped with Event Types. The list can be used to decide which test emails to send. */
+ getEmailTypes: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns a list of all fields, both System and Custom */
+ getFields: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Creates a custom field using a definition (object encapsulating custom field data) */
+ createCustomField: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Creates a new filter, and returns newly created filter.
+ * Currently sets permissions just using the users default sharing permissions
+ */
+ createFilter: {
+ parameters: {
+ query?: {
+ /** @description the parameters to expand */
+ expand?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns the default share scope of the logged-in user. */
+ getDefaultShareScope: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Sets the default share scope of the logged-in user.
+ *
+ * Available values are: AUTHENTICATED (for sharing with all logged-in users) and PRIVATE (for no shares).
+ */
+ setDefaultShareScope: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns the favourite filters of the logged-in user. */
+ getFavouriteFilters: {
+ parameters: {
+ query?: {
+ /** @description the parameters to expand */
+ expand?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns a filter given an id */
+ getFilter: {
+ parameters: {
+ query?: {
+ /** @description the parameters to expand */
+ expand?: string;
+ };
+ path: {
+ /** @description the id of the filter being looked up */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Updates an existing filter, and returns its new value.
+ *
+ * The following properties of a filter can be updated: 'jql', 'name', 'description'.
+ * Additionally, administrators can also update the 'owner' field.
+ * To get, set or unset 'favourite', use rest/api/1.0/filters/{id}/favourite with GET, PUT and DELETE methods instead.
+ *
+ */
+ editFilter: {
+ parameters: {
+ query?: {
+ /** @description the parameters to expand */
+ expand?: string;
+ };
+ path: {
+ /** @description the id of the filter being looked up */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Delete a filter. */
+ deleteFilter: {
+ parameters: {
+ path: {
+ /** @description the id of the filter being looked up */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns the default columns for the given user. Admin permission will be required to get columns for a user
+ * other than the currently logged in user.
+ */
+ defaultColumns: {
+ parameters: {
+ query?: {
+ /** @description username */
+ username?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Sets the default columns for the given user. Admin permission will be required to get columns for a user
+ * other than the currently logged in user.
+ */
+ setColumns: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Reset the default columns for the given user to the system default. Admin permission will be required to get
+ * columns for a user other than the currently logged in user.
+ */
+ resetColumns: {
+ parameters: {
+ query?: {
+ /** @description username */
+ username?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns all share permissions of the given filter. */
+ getSharePermissions: {
+ parameters: {
+ path: {
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Adds a share permissions to the given filter. Adding a global permission removes all previous permissions from the filter. */
+ addSharePermission: {
+ parameters: {
+ path: {
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Removes a share permissions from the given filter. */
+ deleteSharePermission: {
+ parameters: {
+ path: {
+ id: number;
+ "permission-id": number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns a single share permission of the given filter. */
+ getSharePermission: {
+ parameters: {
+ path: {
+ permissionId: number;
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns REST representation for the requested group. Allows to get list of active users belonging to the
+ * specified group and its subgroups if "users" expand option is provided. You can page through users list by using
+ * indexes in expand param. For example to get users from index 10 to index 15 use "users[10:15]" expand value. This
+ * will return 6 users (if there are at least 16 users in this group). Indexes are 0-based and inclusive.
+ *
+ * This resource is deprecated, please use group/member API instead.
+ */
+ getGroup: {
+ parameters: {
+ query?: {
+ /** @description A name of requested group. */
+ groupname?: string;
+ /** @description List of fields to expand. Currently only available expand is "users". */
+ expand?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Creates a group by given group parameter
+ *
+ * Returns REST representation for the requested group.
+ */
+ createGroup: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Deletes a group by given group parameter.
+ *
+ * Returns no content
+ */
+ removeGroup: {
+ parameters: {
+ query?: {
+ /** @description (mandatory) The name of the group to delete. */
+ groupname?: string;
+ /**
+ * @description If you delete a group and content is restricted to that group, the content will be hidden from all users.
+ * To prevent this, use this parameter to specify a different group to transfer the restrictions (comments and worklogs only) to.
+ */
+ swapGroup?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description This resource returns a paginated list of users who are members of the specified group and its subgroups.
+ * Users in the page are ordered by user names. User of this resource is required to have sysadmin or admin permissions.
+ */
+ getUsersFromGroup: {
+ parameters: {
+ query?: {
+ /** @description a name of the group for which members will be returned. */
+ groupname?: string;
+ /** @description inactive users will be included in the response if set to true. */
+ includeInactiveUsers?: boolean;
+ /** @description the index of the first user in group to return (0 based). */
+ startAt?: number;
+ /** @description the maximum number of users to return (max 50). */
+ maxResults?: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Adds given user to a group.
+ *
+ * Returns the current state of the group.
+ */
+ addUserToGroup: {
+ parameters: {
+ query?: {
+ /** @description A name of requested group. */
+ groupname?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Removes given user from a group.
+ *
+ * Returns no content
+ */
+ removeUserFromGroup: {
+ parameters: {
+ query?: {
+ /** @description A name of requested group. */
+ groupname?: string;
+ /** @description User to remove from a group */
+ username?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns groups with substrings matching a given query. This is mainly for use with
+ * the group picker, so the returned groups contain html to be used as picker suggestions.
+ * The groups are also wrapped in a single response object that also contains a header for
+ * use in the picker, specifically Showing X of Y matching groups.
+ *
+ * The number of groups returned is limited by the system property "jira.ajax.autocomplete.limit"
+ *
+ * The groups will be unique and sorted.
+ */
+ findGroups: {
+ parameters: {
+ query?: {
+ /** @description a String to match groups agains */
+ query?: string;
+ exclude?: string;
+ maxResults?: number;
+ userName?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns a list of users and groups matching query with highlighting. This resource cannot be accessed
+ * anonymously.
+ */
+ findUsersAndGroups: {
+ parameters: {
+ query?: {
+ /** @description A string used to search username, Name or e-mail address */
+ query?: string;
+ /**
+ * @description the maximum number of users to return (defaults to 50). The maximum allowed value is 1000. If
+ * you specify a value that is higher than this number, your search results will be truncated.
+ */
+ maxResults?: number;
+ showAvatar?: boolean;
+ /** @description The custom field id, if this request comes from a custom field, such as a user picker. Optional. */
+ fieldId?: string;
+ /**
+ * @description The list of project ids to further restrict the search
+ * This parameter can occur multiple times to pass in multiple project ids.
+ * Comma separated value is not supported.
+ * This parameter is only used when fieldId is present.
+ */
+ projectId?: string;
+ /**
+ * @description The list of issue type ids to further restrict the search.
+ * This parameter can occur multiple times to pass in multiple issue type ids.
+ * Comma separated value is not supported.
+ * Special values such as -1 (all standard issue types), -2 (all subtask issue types) are supported.
+ * This parameter is only used when fieldId is present.
+ */
+ issueTypeId?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Lists available index snapshots absolute paths with timestamps.
+ *
+ * Only System Administrator can request listing index snapshots.
+ */
+ listIndexSnapshot: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Tries to start taking an index snapshot if no other snapshot creation process is in progress.
+ * Performs a cleanup of index snapshots directory so only a limited number of most recent snapshots are persisted.
+ * If another snapshot creation process is in progress, returns 409 without waiting for the other process to complete.
+ *
+ * Only System Administrator can request creation of snapshot. There is no guarantee as to the time after which the snapshot will be available.
+ */
+ createIndexSnapshot: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Answers true if index snapshot creation is currently running.
+ *
+ * Only System Administrator can request current snapshot creation status.
+ */
+ isIndexSnapshotRunning: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Summarizes index condition of current node.
+ *
+ * Returned data consists of:
+ *
+ * nodeId - Node identifier.reportTime - Time of this report creation.issueIndex - Summary of issue index status.replicationQueues - Map of index replication queues, where
+ * keys represent nodes from which replication operations came from.
+ *
+ * issueIndex can contain:
+ *
+ * indexReadable - If false the end point failed to read data from issue index
+ * (check Jira logs for detailed stack trace), otherwise true.
+ * When false other fields of issueIndex can be not visible.countInDatabase - Count of issues found in database.countInIndex - Count of issues found while querying index.lastUpdatedInDatabase - Time of last update of issue found in database.lastUpdatedInIndex - Time of last update of issue found while querying index.
+ *
+ * replicationQueues's map values can contain:
+ *
+ * lastConsumedOperation - Last executed index replication operation by current node from sending node's queue.lastConsumedOperation.id - Identifier of the operation.lastConsumedOperation.replicationTime - Time when the operation was sent to other nodes.lastOperationInQueue - Last index replication operation in sending node's queue.lastOperationInQueue.id - Identifier of the operation.lastOperationInQueue.replicationTime - Time when the operation was sent to other nodes.queueSize - Number of operations in queue from sending node to current node.
+ */
+ getIndexSummary: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Creates an issue or a sub-task from a JSON representation.
+ *
+ * The fields that can be set on create, in either the fields parameter or the update parameter can be determined
+ * using the /rest/api/2/issue/createmeta resource.
+ * If a field is not configured to appear on the create screen, then it will not be in the createmeta, and a field
+ * validation error will occur if it is submitted.
+ *
+ * Creating a sub-task is similar to creating a regular issue, with two important differences:
+ *
+ * - the
issueType field must correspond to a sub-task issue type (you can use
+ * /issue/createmeta to discover sub-task issue types), and
+ * - you must provide a
parent field in the issue create request containing the id or key of the
+ * parent issue.
+ * - The
updateHistory param adds the project that this issue is created in, to the current user's project history,
+ * if set to true (by default, the project history is not updated).
+ * - You can view the project history in the Jira application, via the Projects dropdown.
+ *
+ */
+ createIssue: {
+ parameters: {
+ query?: {
+ /** @description if true then the user's project history is updated */
+ updateHistory?: boolean;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Archives a list of issues. */
+ archiveIssues: {
+ parameters: {
+ query?: {
+ /**
+ * @description send the email with notification that the issue was updated to users that watch it.
+ * Admin or project admin permissions are required to disable the notification.
+ */
+ notifyUsers?: boolean;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Creates issues or sub-tasks from a JSON representation.
+ *
+ * Creates many issues in one bulk operation.
+ *
+ * Creating a sub-task is similar to creating a regular issue. More details can be found in createIssue section:
+ * {@link IssueResource#createIssue(boolean, IssueUpdateBean)}}}
+ */
+ createIssues: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns the metadata for issue types used for creating issues.
+ * Data will not be returned if the user does not have permission to create issues in that project.
+ */
+ getCreateIssueMetaProjectIssueTypes: {
+ parameters: {
+ query?: {
+ /** @description the page offset, if not specified then defaults to 0 */
+ startAt?: number;
+ /** @description how many results on the page should be included. Defaults to 50. */
+ maxResults?: number;
+ };
+ path: {
+ /** @description to get metadata for */
+ projectIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns the metadata for issue types used for creating issues.
+ * Data will not be returned if the user does not have permission to create issues in that project.
+ */
+ getCreateIssueMetaFields: {
+ parameters: {
+ query?: {
+ /** @description the page offset, if not specified then defaults to 0 */
+ startAt?: number;
+ /** @description how many results on the page should be included. Defaults to 50. */
+ maxResults?: number;
+ };
+ path: {
+ /** @description to get metadata for */
+ issueTypeId: string;
+ /** @description to get metadata for */
+ projectIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns suggested issues which match the auto-completion query for the user which executes this request. This REST
+ * method will check the user's history and the user's browsing context and select this issues, which match the query.
+ */
+ getIssuePickerResource: {
+ parameters: {
+ query?: {
+ /** @description the query. */
+ query?: string;
+ /** @description the JQL in context of which the request is executed. Only issues which match this JQL query will be included in results. */
+ currentJQL?: string;
+ /** @description the key of the issue in context of which the request is executed. The issue which is in context will not be included in the auto-completion result, even if it matches the query. */
+ currentIssueKey?: string;
+ /** @description the id of the project in context of which the request is executed. Suggested issues will be only from this project. */
+ currentProjectId?: string;
+ /** @description if set to false, subtasks will not be included in the list. */
+ showSubTasks?: boolean;
+ /** @description if set to false and request is executed in context of a subtask, the parent issue will not be included in the auto-completion result, even if it matches the query. */
+ showSubTaskParent?: boolean;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns a full representation of the issue for the given issue key.
+ *
+ * An issue JSON consists of the issue key, a collection of fields,
+ * a link to the workflow transition sub-resource, and (optionally) the HTML rendered values of any fields that support it
+ * (e.g. if wiki syntax is enabled for the description or comments).
+ *
+ * The fields param (which can be specified multiple times) gives a comma-separated list of fields
+ * to include in the response. This can be used to retrieve a subset of fields.
+ * A particular field can be excluded by prefixing it with a minus.
+ *
+ * By default, all (*all) fields are returned in this get-issue resource. Note: the default is different
+ * when doing a jql search -- the default there is just navigable fields (*navigable).
+ *
+ * *all - include all fields*navigable - include just navigable fieldssummary,comment - include just the summary and comments-comment - include everything except comments (the default is *all for get-issue)*all,-comment - include everything except comments
+ *
+ * The {@code properties} param is similar to {@code fields} and specifies a comma-separated list of issue
+ * properties to include. Unlike {@code fields}, properties are not included by default. To include them all
+ * send {@code ?properties=*all}. You can also include only specified properties or exclude some properties
+ * with a minus (-) sign.
+ *
+ *
+ * - {@code *all} - include all properties
+ * - {@code *all, -prop1} - include all properties except {@code prop1}
+ * - {@code prop1, prop1} - include {@code prop1} and {@code prop2} properties
+ *
+ *
+ *
+ * Jira will attempt to identify the issue by the issueIdOrKey path parameter. This can be an issue id,
+ * or an issue key. If the issue cannot be found via an exact match, Jira will also look for the issue in a case-insensitive way, or
+ * by looking to see if the issue was moved. In either of these cases, the request will proceed as normal (a 302 or other redirect
+ * will not be returned). The issue key contained in the response will indicate the current value of issue's key.
+ *
+ * The expand param is used to include, hidden by default, parts of response. This can be used to include:
+ *
+ * renderedFields - field values in HTML formatnames - display name of each fieldschema - schema for each field which describes a type of the fieldtransitions - all possible transitions for the given issueoperations - all possibles operations which may be applied on issueeditmeta - information about how each field may be edited. It contains field's schema as well.changelog - history of all changes of the given issueversionedRepresentations -
+ * REST representations of all fields. Some field may contain more recent versions. RESET representations are numbered.
+ * The greatest number always represents the most recent version. It is recommended that the most recent version is used.
+ * version for these fields which provide a more recent REST representation.
+ * After including versionedRepresentations "fields" field become hidden.
+ */
+ getIssue: {
+ parameters: {
+ query?: {
+ /** @description the list of fields to return for the issue. By default, all fields are returned. */
+ fields?: string;
+ expand?: string;
+ /** @description the list of properties to return for the issue. By default no properties are returned. */
+ properties?: string;
+ updateHistory?: boolean;
+ };
+ path: {
+ /** @description the issue id or key to update (i.e. JRA-1330) */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Edits an issue from a JSON representation.
+ *
+ * The issue can either be updated by setting explicit the field value(s)
+ * or by using an operation to change the field value.
+ *
+ * The fields that can be updated, in either the fields parameter or the update parameter, can be determined
+ * using the /rest/api/2/issue/{issueIdOrKey}/editmeta resource.
+ * If a field is not configured to appear on the edit screen, then it will not be in the editmeta, and a field
+ * validation error will occur if it is submitted.
+ *
+ * Specifying a "field_id": field_value in the "fields" is a shorthand for a "set" operation in the "update" section.
+ * Field should appear either in "fields" or "update", not in both.
+ */
+ editIssue: {
+ parameters: {
+ query?: {
+ /**
+ * @description send the email with notification that the issue was updated to users that watch it.
+ * Admin or project admin permissions are required to disable the notification.
+ */
+ notifyUsers?: boolean;
+ };
+ path: {
+ /** @description the issue id or key to update (i.e. JRA-1330) */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Delete an issue.
+ *
+ * If the issue has subtasks you must set the parameter deleteSubtasks=true to delete the issue.
+ * You cannot delete an issue without its subtasks also being deleted.
+ */
+ deleteIssue: {
+ parameters: {
+ query?: {
+ /**
+ * @description a String of true or false indicating that any subtasks should also be deleted. If the
+ * issue has no subtasks this parameter is ignored. If the issue has subtasks and this parameter is missing or false,
+ * then the issue will not be deleted and an error will be returned.
+ */
+ deleteSubtasks?: string;
+ };
+ path: {
+ /** @description the issue id or key to update (i.e. JRA-1330) */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Archives an issue. */
+ archiveIssue: {
+ parameters: {
+ query?: {
+ /**
+ * @description send the email with notification that the issue was updated to users that watch it.
+ * Admin or project admin permissions are required to disable the notification.
+ */
+ notifyUsers?: boolean;
+ };
+ path: {
+ /** @description Issue id or issue key */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Assigns an issue to a user.
+ * You can use this resource to assign issues when the user submitting the request has the assign permission but not the
+ * edit issue permission.
+ * If the name is "-1" automatic assignee is used. A null name will remove the assignee.
+ */
+ assign: {
+ parameters: {
+ path: {
+ /** @description a String containing an issue key */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Add one or more attachments to an issue.
+ *
+ * This resource expects a multipart post. The media-type multipart/form-data is defined in RFC 1867. Most client
+ * libraries have classes that make dealing with multipart posts simple. For instance, in Java the Apache HTTP Components
+ * library provides a
+ * MultiPartEntity
+ * that makes it simple to submit a multipart POST.
+ *
+ * In order to protect against XSRF attacks, because this method accepts multipart/form-data, it has XSRF protection
+ * on it. This means you must submit a header of X-Atlassian-Token: no-check with the request, otherwise it will be
+ * blocked.
+ *
+ * The name of the multipart/form-data parameter that contains attachments must be "file"
+ *
+ * A simple example to upload a file called "myfile.txt" to issue REST-123:
+ *
curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: no-check" -F "file=@myfile.txt" http://myhost/rest/api/2/issue/TEST-123/attachments
+ */
+ addAttachment: {
+ parameters: {
+ path: {
+ /** @description the issue that you want to add the attachments to */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns all comments for an issue.
+ *
+ * Results can be ordered by the "created" field which means the date a comment was added.
+ *
+ */
+ getComments: {
+ parameters: {
+ query?: {
+ /** @description the page offset, if not specified then defaults to 0 */
+ startAt?: number;
+ /** @description how many results on the page should be included. Defaults to 50. */
+ maxResults?: number;
+ /** @description ordering of the results. */
+ orderBy?: string;
+ /** @description optional flags: renderedBody (provides body rendered in HTML) */
+ expand?: string;
+ };
+ path: {
+ /** @description a string containing the issue id or key the comment will be added to */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Adds a new comment to an issue. */
+ addComment: {
+ parameters: {
+ query?: {
+ /** @description optional flags: renderedBody (provides body rendered in HTML) */
+ expand?: string;
+ };
+ path: {
+ /** @description a string containing the issue id or key the comment will be added to */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns a single comment. */
+ getComment: {
+ parameters: {
+ query?: {
+ /** @description optional flags: renderedBody (provides body rendered in HTML) */
+ expand?: string;
+ };
+ path: {
+ /** @description of the issue the comment belongs to */
+ issueIdOrKey: string;
+ /** @description the ID of the comment to request */
+ id: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Updates an existing comment using its JSON representation. */
+ updateComment: {
+ parameters: {
+ query?: {
+ /** @description optional flags: renderedBody (provides body rendered in HTML) */
+ expand?: string;
+ };
+ path: {
+ /** @description of the issue the comment belongs to */
+ issueIdOrKey: string;
+ /** @description the ID of the comment to request */
+ id: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Deletes an existing comment . */
+ deleteComment: {
+ parameters: {
+ path: {
+ /** @description of the issue the comment belongs to */
+ issueIdOrKey: string;
+ /** @description the ID of the comment to request */
+ id: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ setPinComment: {
+ parameters: {
+ path: {
+ issueIdOrKey: string;
+ id: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns the meta data for editing an issue.
+ *
+ * The fields in the editmeta correspond to the fields in the edit screen for the issue.
+ * Fields not in the screen will not be in the editmeta.
+ */
+ getEditIssueMeta: {
+ parameters: {
+ path: {
+ /** @description the issue whose edit meta data you want to view */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Sends a notification (email) to the list or recipients defined in the request. */
+ notify: {
+ parameters: {
+ path: {
+ /** @description a string containing the issue id or key the comment will be added to */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns all pinned to the issue comments. */
+ getPinnedComments: {
+ parameters: {
+ path: {
+ /** @description of the issue the comment belongs to */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description A REST sub-resource representing the remote issue links on the issue. */
+ getRemoteIssueLinks: {
+ parameters: {
+ query?: {
+ /**
+ * @description The id of the remote issue link to be returned. If null (not provided) all remote links for the
+ * issue are returned.
+ * For a fullexplanation of Issue Link fields please refer to
+ * https://developer.atlassian.com/display/JIRADEV/Fields+in+Remote+Issue+Links
+ */
+ globalId?: string;
+ };
+ path: {
+ /** @description the issue to create the remote issue link for */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Creates or updates a remote issue link from a JSON representation. If a globalId is provided and a remote issue link
+ * exists with that globalId, the remote issue link is updated. Otherwise, the remote issue link is created.
+ */
+ createOrUpdateRemoteIssueLink: {
+ parameters: {
+ path: {
+ /** @description the issue to create the remote issue link for */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Delete the remote issue link with the given global id on the issue. */
+ deleteRemoteIssueLinkByGlobalId: {
+ parameters: {
+ query?: {
+ /** @description the global id of the remote issue link */
+ globalId?: string;
+ };
+ path: {
+ /** @description the issue to create the remote issue link for */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Get the remote issue link with the given id on the issue. */
+ getRemoteIssueLinkById: {
+ parameters: {
+ path: {
+ /** @description the id of the remote issue link */
+ linkId: string;
+ /** @description the issue to create the remote issue link for */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Updates a remote issue link from a JSON representation. Any fields not provided are set to null. */
+ updateRemoteIssueLink: {
+ parameters: {
+ path: {
+ /** @description the id of the remote issue link */
+ linkId: string;
+ /** @description the issue to create the remote issue link for */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Delete the remote issue link with the given id on the issue. */
+ deleteRemoteIssueLinkById: {
+ parameters: {
+ path: {
+ /** @description the id of the remote issue link */
+ linkId: string;
+ /** @description the issue to create the remote issue link for */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Restores an archived issue. */
+ restoreIssue: {
+ parameters: {
+ query?: {
+ /**
+ * @description send the email with notification that the issue was updated to users that watch it.
+ * Admin or project admin permissions are required to disable the notification.
+ */
+ notifyUsers?: boolean;
+ };
+ path: {
+ /** @description Issue id or issue key */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns an issue's subtask list */
+ getSubTasks: {
+ parameters: {
+ path: {
+ /** @description The parent issue's key or id */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ canMoveSubTask: {
+ parameters: {
+ path: {
+ /** @description The parent issue's key or id */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Reorders an issue's subtasks by moving the subtask at index "from"
+ * to index "to".
+ */
+ moveSubTasks: {
+ parameters: {
+ path: {
+ /** @description The parent issue's key or id */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Get a list of the transitions possible for this issue by the current user, along with fields that are required and their types.
+ *
+ * Fields will only be returned if expand=transitions.fields.
+ *
+ * The fields in the metadata correspond to the fields in the transition screen for that transition.
+ * Fields not in the screen will not be in the metadata.
+ */
+ getTransitions: {
+ parameters: {
+ query?: {
+ transitionId?: string;
+ };
+ path: {
+ /** @description the issue you want to transition */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Perform a transition on an issue.
+ * When performing the transition you can update or set other issue fields.
+ *
+ * The fields that can be set on transtion, in either the fields parameter or the update parameter can be determined
+ * using the /rest/api/2/issue/{issueIdOrKey}/transitions?expand=transitions.fields resource.
+ * If a field is not configured to appear on the transition screen, then it will not be in the transition metadata, and a field
+ * validation error will occur if it is submitted.
+ *
+ * The updateHistory param adds the issues retrieved by this method to the current user's issue history,
+ * if set to true (by default, the issue history does not include issues retrieved via the REST API).
+ * You can view the issue history in the Jira application, via the Issues dropdown or by using the
+ * lastViewed JQL field in an issue search.
+ */
+ doTransition: {
+ parameters: {
+ path: {
+ /** @description the issue you want to transition */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description A REST sub-resource representing the voters on the issue. */
+ getVotes: {
+ parameters: {
+ path: {
+ /** @description the issue to view voting information for */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Cast your vote in favour of an issue. */
+ addVote: {
+ parameters: {
+ path: {
+ /** @description the issue to view voting information for */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Remove your vote from an issue. (i.e. "unvote") */
+ removeVote: {
+ parameters: {
+ path: {
+ /** @description the issue to view voting information for */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns the list of watchers for the issue with the given key. */
+ getIssueWatchers: {
+ parameters: {
+ path: {
+ /** @description a String containing an issue key. */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Adds a user to an issue's watcher list. */
+ addWatcher: {
+ parameters: {
+ path: {
+ /** @description a String containing an issue key. */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Removes a user from an issue's watcher list. */
+ removeWatcher: {
+ parameters: {
+ query?: {
+ /** @description a String containing the name of the user to remove from the watcher list. Must not be null. */
+ username?: string;
+ };
+ path: {
+ /** @description a String containing an issue key. */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns all work logs for an issue.
+ * Note: Work logs won't be returned if the Log work field is hidden for the project.
+ */
+ getIssueWorklog: {
+ parameters: {
+ path: {
+ /** @description a string containing the issue id or key the worklog will be added to */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Adds a new worklog entry to an issue. */
+ addWorklog: {
+ parameters: {
+ query?: {
+ /**
+ * @description (optional) allows you to provide specific instructions to update the remaining time estimate of the issue. Valid values are
+ *
+ * - "new" - sets the estimate to a specific value
+ * - "leave"- leaves the estimate as is
+ * - "manual" - specify a specific amount to increase remaining estimate by
+ * - "auto"- Default option. Will automatically adjust the value based on the new timeSpent specified on the worklog
+ */
+ adjustEstimate?: string;
+ /** @description (required when "new" is selected for adjustEstimate) the new value for the remaining estimate field. e.g. "2d" */
+ newEstimate?: string;
+ /** @description (required when "manual" is selected for adjustEstimate) the amount to reduce the remaining estimate by e.g. "2d" */
+ reduceBy?: string;
+ };
+ path: {
+ /** @description a string containing the issue id or key the worklog will be added to */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns a specific worklog.
+ * Note: The work log won't be returned if the Log work field is hidden for the project.
+ */
+ getWorklog: {
+ parameters: {
+ path: {
+ /** @description a string containing the issue id or key the worklog belongs to */
+ issueIdOrKey: string;
+ /** @description id of the worklog to be deleted */
+ id: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Updates an existing worklog entry.
+ * Note that:
+ *
+ * - Fields possible for editing are: comment, visibility, started, timeSpent and timeSpentSeconds.
+ * - Either timeSpent or timeSpentSeconds can be set.
+ * - Fields which are not set will not be updated.
+ * - For a request to be valid, it has to have at least one field change.
+ *
+ */
+ updateWorklog: {
+ parameters: {
+ query?: {
+ /**
+ * @description (optional) allows you to provide specific instructions to update the remaining time estimate of the issue. Valid values are
+ *
+ * - "new" - sets the estimate to a specific value
+ * - "leave"- leaves the estimate as is
+ * - "auto"- Default option. Will automatically adjust the value based on the new timeSpent specified on the worklog
+ */
+ adjustEstimate?: string;
+ /** @description (required when "new" is selected for adjustEstimate) the new value for the remaining estimate field. */
+ newEstimate?: string;
+ };
+ path: {
+ /** @description a string containing the issue id or key the worklog belongs to */
+ issueIdOrKey: string;
+ /** @description id of the worklog to be deleted */
+ id: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Deletes an existing worklog entry. */
+ deleteWorklog: {
+ parameters: {
+ query?: {
+ /**
+ * @description (optional) allows you to provide specific instructions to update the remaining time estimate of the issue. Valid values are
+ *
+ * - "new" - sets the estimate to a specific value
+ * - "leave"- leaves the estimate as is
+ * - "manual" - specify a specific amount to increase remaining estimate by
+ * - "auto"- Default option. Will automatically adjust the value based on the new timeSpent specified on the worklog
+ */
+ adjustEstimate?: string;
+ /** @description (required when "new" is selected for adjustEstimate) the new value for the remaining estimate field. e.g. "2d" */
+ newEstimate?: string;
+ /** @description (required when "manual" is selected for adjustEstimate) the amount to increase the remaining estimate by e.g. "2d" */
+ increaseBy?: string;
+ };
+ path: {
+ /** @description a string containing the issue id or key the worklog belongs to */
+ issueIdOrKey: string;
+ /** @description id of the worklog to be deleted */
+ id: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Creates an issue link between two issues.
+ * The user requires the link issue permission for the issue which will be linked to another issue.
+ * The specified link type in the request is used to create the link and will create a link from the first issue
+ * to the second issue using the outward description. It also create a link from the second issue to the first issue using the
+ * inward description of the issue link type.
+ * It will add the supplied comment to the first issue. The comment can have a restriction who can view it.
+ * If group is specified, only users of this group can view this comment, if roleLevel is specified only users who have the specified role can view this comment.
+ * The user who creates the issue link needs to belong to the specified group or have the specified role.
+ */
+ linkIssues: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns an issue link with the specified id. */
+ getIssueLink: {
+ parameters: {
+ path: {
+ /** @description the issue link id. */
+ linkId: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Deletes an issue link with the specified id.
+ * To be able to delete an issue link you must be able to view both issues and must have the link issue permission
+ * for at least one of the issues.
+ */
+ deleteIssueLink: {
+ parameters: {
+ path: {
+ /** @description the issue link id. */
+ linkId: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns a list of available issue link types, if issue linking is enabled.
+ * Each issue link type has an id, a name and a label for the outward and inward link relationship.
+ */
+ getIssueLinkTypes: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Create a new issue link type. */
+ createIssueLinkType: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns for a given issue link type id all information about this issue link type. */
+ getIssueLinkType: {
+ parameters: {
+ path: {
+ issueLinkTypeId: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Update the specified issue link type. */
+ updateIssueLinkType: {
+ parameters: {
+ path: {
+ issueLinkTypeId: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Delete the specified issue link type. */
+ deleteIssueLinkType: {
+ parameters: {
+ path: {
+ issueLinkTypeId: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns all issue security schemes that are defined. */
+ getIssueSecuritySchemes: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns the issue security scheme for project. */
+ getIssueSecurityScheme: {
+ parameters: {
+ path: {
+ projectKeyOrId: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns a list of all issue types visible to the user */
+ getIssueAllTypes: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Creates an issue type from a JSON representation and adds the issue newly created issue type to the default issue
+ * type scheme.
+ */
+ createIssueType: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns paginated list of filtered issue types */
+ getPaginatedIssueTypes: {
+ parameters: {
+ query?: {
+ /** @description the index of the first issue type to return */
+ startAt?: number;
+ /** @description the maximum number of issue type to return */
+ maxResults?: number;
+ /** @description the string that issue type names will be matched with */
+ query?: string;
+ /** @description the set of project ids to filter issue types */
+ projectIds?: string;
+ };
+ header?: {
+ "X-Requested-With"?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns the issue type mapping for the passed workflow scheme. */
+ getIssueType: {
+ parameters: {
+ query?: {
+ /**
+ * @description when true indicates that a scheme's draft, if it exists, should be queried instead of
+ * the scheme itself.
+ */
+ returnDraftIfExists?: boolean;
+ };
+ path: {
+ /** @description the issue type being set. */
+ issueType: string;
+ /** @description the id of the scheme. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Updates the specified issue type from a JSON representation. */
+ updateIssueType: {
+ parameters: {
+ path: {
+ /** @description a String containing an issue type id */
+ id: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Remove the specified issue type mapping from the scheme. */
+ deleteIssueType: {
+ parameters: {
+ query?: {
+ /**
+ * @description when true will create and return a draft when the workflow scheme cannot be edited
+ * (e.g. when it is being used by a project).
+ */
+ updateDraftIfNeeded?: boolean;
+ };
+ path: {
+ /** @description the issue type being set. */
+ issueType: string;
+ /** @description the id of the scheme. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns a list of all alternative issue types for the given issue type id. The list will contain these issues types, to which
+ * issues assigned to the given issue type can be migrated. The suitable alternatives are issue types which are assigned
+ * to the same workflow, the same field configuration and the same screen scheme.
+ */
+ getAlternativeIssueTypes: {
+ parameters: {
+ path: {
+ id: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Creates temporary avatar using multipart. The response is sent back as JSON stored in a textarea. This is because
+ * the client uses remote iframing to submit avatars using multipart. So we must send them a valid HTML page back from
+ * which the client parses the JSON from.
+ *
+ * Creating a temporary avatar is part of a 3-step process in uploading a new
+ * avatar for a user: upload, crop, confirm. This endpoint allows you to use a multipart upload
+ * instead of sending the image directly as the request body.
+ *
+ *
+ * You *must* use "avatar" as the name of the upload parameter:
+ *
+ *
+ * curl -c cookiejar.txt -X POST -u admin:admin -H "X-Atlassian-Token: no-check" \
+ * -F "avatar=@mynewavatar.png;type=image/png" \
+ * 'http://localhost:8090/jira/rest/api/2/user/avatar/temporary?username=admin'
+ *
+ */
+ storeTemporaryAvatarUsingMultiPart: {
+ parameters: {
+ query?: {
+ /** @description Username */
+ username?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns the keys of all properties for the issue type identified by the id. */
+ getPropertyKeys: {
+ parameters: {
+ path: {
+ /** @description the issue type from which the keys will be returned */
+ issueTypeId: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns a list of all issue type schemes visible to the user (must be admin).
+ *
+ * All issue types associated with the scheme will only be returned if an additional query parameter is provided:
+ * expand=schemes.issueTypes.
+ *
+ *
+ * Similarly, the default issue type associated with the scheme (if one exists) will only be returned if
+ * additional an query parameter is provided: expand=schemes.defaultIssueType.
+ *
+ *
+ * Note that both query parameters can be used together: expand=schemes.issueTypes,schemes.defaultIssueType.
+ *
+ */
+ getAllIssueTypeSchemes: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Creates an issue type scheme from a JSON representation. (Admin required) */
+ createIssueTypeScheme: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns a full representation of the issue type scheme that has the given id (must be admin). */
+ getIssueTypeScheme: {
+ parameters: {
+ path: {
+ /** @description the id of the issue type scheme to remove. */
+ schemeId: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Updates the specified issue type scheme from a JSON representation. (Admin required) */
+ updateIssueTypeScheme: {
+ parameters: {
+ path: {
+ /** @description the id of the issue type scheme to remove. */
+ schemeId: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Deletes the specified issue type scheme. Any projects associated with this IssueTypeScheme will be automatically
+ * associated with the global default IssueTypeScheme. (Admin required)
+ */
+ deleteIssueTypeScheme: {
+ parameters: {
+ path: {
+ /** @description the id of the issue type scheme to remove. */
+ schemeId: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description For the specified issue type scheme, returns all of the associated projects. (Admin required) */
+ getAssociatedProjects: {
+ parameters: {
+ query?: {
+ /** @description the parameters to expand on the returned projects; defaults to none. */
+ expand?: string;
+ };
+ path: {
+ /** @description the id of the issue type scheme whose project associations we're removing */
+ schemeId: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Associates the given projects with the specified issue type scheme. Any existing project-associations the issue
+ * type scheme has will be overwritten. (Admin required)
+ */
+ setProjectAssociationsForScheme: {
+ parameters: {
+ path: {
+ /** @description the id of the issue type scheme whose project associations we're removing */
+ schemeId: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Adds additional projects to those already associated with the specified issue type scheme. (Admin required) */
+ addProjectAssociationsToScheme: {
+ parameters: {
+ path: {
+ /** @description the id of the issue type scheme whose project associations we're removing */
+ schemeId: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Removes all project associations for the specified issue type scheme. These projects revert to an association with
+ * the default/global issue type scheme.(Admin required)
+ */
+ removeAllProjectAssociations: {
+ parameters: {
+ path: {
+ /** @description the id of the issue type scheme whose project associations we're removing */
+ schemeId: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description For the specified issue type scheme, removes the given project association . This project reverts to an association
+ * with the default/global issue type scheme.(Admin required)
+ */
+ removeProjectAssociation: {
+ parameters: {
+ path: {
+ /** @description the id or key of the project that is to be un-associated with the issue type scheme */
+ projIdOrKey: string;
+ /** @description the id of the issue type scheme whose project association we're removing */
+ schemeId: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns the auto complete data required for JQL searches. */
+ getAutoComplete: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns auto complete suggestions for JQL search. */
+ getFieldAutoCompleteForQueryString: {
+ parameters: {
+ query?: {
+ /** @description the field name for which the suggestions are generated. */
+ fieldName?: string;
+ /** @description the portion of the field value that has already been provided by the user. */
+ fieldValue?: string;
+ /** @description the predicate for which the suggestions are generated. Suggestions are generated only for: "by", "from" and "to". */
+ predicateName?: string;
+ /** @description the portion of the predicate value that has already been provided by the user. */
+ predicateValue?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ validate: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ isAppMonitoringEnabled: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ setAppMonitoringEnabled: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ isIpdMonitoringEnabled: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ areMetricsExposed: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ getAvailableMetrics: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ start: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ stop: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns all permissions in the system and whether the currently logged in user has them. You can optionally provide a specific context to get permissions for
+ * (projectKey OR projectId OR issueKey OR issueId)
+ *
+ * - When no context supplied the project related permissions will return true if the user has that permission in ANY project
+ * - If a project context is provided, project related permissions will return true if the user has the permissions in the specified project.
+ * For permissions that are determined using issue data (e.g Current Assignee), true will be returned if the user meets the permission criteria in ANY issue in that project
+ * - If an issue context is provided, it will return whether or not the user has each permission in that specific issue
+ *
+ *
+ * NB: The above means that for issue-level permissions (EDIT_ISSUE for example), hasPermission may be true when no context is provided, or when a project context is provided,
+ * but may be false for any given (or all) issues. This would occur (for example) if Reporters were given the EDIT_ISSUE permission. This is because
+ * any user could be a reporter, except in the context of a concrete issue, where the reporter is known.
+ *
+ *
+ * Global permissions will still be returned for all scopes.
+ *
+ *
+ * Prior to version 6.4 this service returned project permissions with keys corresponding to com.atlassian.jira.security.Permissions.Permission constants.
+ * Since 6.4 those keys are considered deprecated and this service returns system project permission keys corresponding to constants defined in com.atlassian.jira.permission.ProjectPermissions.
+ * Permissions with legacy keys are still also returned for backwards compatibility, they are marked with an attribute deprecatedKey=true.
+ * The attribute is missing for project permissions with the current keys.
+ *
+ */
+ getPermissions: {
+ parameters: {
+ query?: {
+ /** @description - key of project to scope returned permissions for. */
+ projectKey?: string;
+ /** @description - id of project to scope returned permissions for. */
+ projectId?: string;
+ /** @description - key of the issue to scope returned permissions for. */
+ issueKey?: string;
+ /** @description - id of the issue to scope returned permissions for. */
+ issueId?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns preference of the currently logged in user. Preference key must be provided as input parameter (key). The
+ * value is returned exactly as it is. If key parameter is not provided or wrong - status code 404. If value is
+ * found - status code 200.
+ */
+ getPreference: {
+ parameters: {
+ query?: {
+ /** @description - key of the preference to be returned. */
+ key?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Sets preference of the currently logged in user. Preference key must be provided as input parameters (key). Value
+ * must be provided as post body. If key or value parameter is not provided - status code 404. If preference is set
+ * - status code 204.
+ */
+ setPreference: {
+ parameters: {
+ query?: {
+ /** @description - key of the preference to be set. */
+ key?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Removes preference of the currently logged in user. Preference key must be provided as input parameters (key). If
+ * key parameter is not provided or wrong - status code 404. If preference is unset - status code 204.
+ */
+ removePreference: {
+ parameters: {
+ query?: {
+ /** @description - key of the preference to be removed. */
+ key?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns a user. This resource cannot be accessed anonymously. */
+ getUser: {
+ parameters: {
+ query?: {
+ /** @description the username */
+ username?: string;
+ /** @description user key */
+ key?: string;
+ /** @description whether deleted users should be returned (flag available to users with global ADMIN rights) */
+ includeDeleted?: boolean;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Modify user. The "value" fields present will override the existing value.
+ * Fields skipped in request will not be changed.
+ */
+ updateUser: {
+ parameters: {
+ query?: {
+ /** @description the username */
+ username?: string;
+ /** @description user key */
+ key?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Modify caller password. */
+ changeMyPassword: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns a paginated list of notification schemes. In order to access notification scheme, the calling user is
+ * required to have permissions to administer at least one project associated with the requested notification scheme. Each scheme contains
+ * a list of events and recipient configured to receive notifications for these events. Consumer should allow events without recipients to appear in response.
+ * The list is ordered by the scheme's name.
+ * Follow the documentation of /notificationscheme/{id} resource for all details about returned value.
+ */
+ getNotificationSchemes: {
+ parameters: {
+ query?: {
+ /** @description the index of the first notification scheme to return (0 based). */
+ startAt?: number;
+ /** @description the maximum number of notification schemes to return (max 50). */
+ maxResults?: number;
+ expand?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Gets a notification scheme associated with the project.
+ * Follow the documentation of /notificationscheme/{id} resource for all details about returned value.
+ */
+ getNotificationScheme: {
+ parameters: {
+ query?: {
+ expand?: string;
+ };
+ path: {
+ /** @description key or id of the project */
+ projectKeyOrId: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns the list of requirements for the current password policy. For example, "The password must have at least 10 characters.",
+ * "The password must not be similar to the user's name or email address.", etc.
+ */
+ getPasswordPolicy: {
+ parameters: {
+ query?: {
+ /**
+ * @description whether or not the user will be required to enter their current password. Use
+ * {@code false} (the default) if this is a new user or if an administrator is forcibly changing
+ * another user's password.
+ */
+ hasOldPassword?: boolean;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns a list of statements explaining why the password policy would disallow a proposed password for a new user.
+ *
+ * You can use this method to test the password policy validation. This could be done prior to an action
+ * where a new user and related password are created, using methods like the ones in
+ * UserService.
+ * For example, you could use this to validate a password in a create user form in the user interface, as the user enters it.
+ * The username and new password must be not empty to perform the validation.
+ * Note, this method will help you validate against the policy only. It won't check any other validations that might be performed
+ * when creating a new user, e.g. checking whether a user with the same name already exists.
+ *
+ */
+ policyCheckCreateUser: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns a list of statements explaining why the password policy would disallow a proposed new password for a user with an existing password.
+ *
+ * You can use this method to test the password policy validation. This could be done prior to an action where the password
+ * is actually updated, using methods like ChangePassword
+ * or ResetPassword.
+ * For example, you could use this to validate a password in a change password form in the user interface, as the user enters it.
+ * The user must exist and the username and new password must be not empty, to perform the validation.
+ * Note, this method will help you validate against the policy only. It won't check any other validations that might be performed
+ * when submitting a password change/reset request, e.g. verifying whether the old password is valid.
+ *
+ */
+ policyCheckUpdateUser: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns all permissions that are present in the Jira instance - Global, Project and the global ones added by plugins */
+ getAllPermissions: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns a list of all permission schemes.
+ *
+ * By default only shortened beans are returned. If you want to include permissions of all the schemes,
+ * then specify the permissions expand parameter. Permissions will be included also if you specify
+ * any other expand parameter.
+ *
+ */
+ getPermissionSchemes: {
+ parameters: {
+ query?: {
+ expand?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Create a new permission scheme.
+ * This method can create schemes with a defined permission set, or without.
+ */
+ createPermissionScheme: {
+ parameters: {
+ query?: {
+ expand?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ getSchemeAttribute: {
+ parameters: {
+ path: {
+ /** @description permission scheme id */
+ permissionSchemeId: number;
+ /** @description permission scheme attribute key */
+ attributeKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Updates or inserts the attribute for a permission scheme specified by permission scheme id.
+ * The attribute consists of the key and the value. The value will be converted to Boolean using Boolean#valueOf.
+ */
+ setSchemeAttribute: {
+ parameters: {
+ path: {
+ /** @description permission scheme id */
+ permissionSchemeId: number;
+ /** @description permission scheme attribute key */
+ key: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns a permission scheme identified by the given id. */
+ getPermissionScheme: {
+ parameters: {
+ query?: {
+ expand?: string;
+ };
+ path: {
+ schemeId: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Updates a permission scheme.
+ *
+ * If the permissions list is present then it will be set in the permission scheme, which basically means it will overwrite any permission grants that
+ * existed in the permission scheme. Sending an empty list will remove all permission grants from the permission scheme.
+ *
+ *
+ * To update just the name and description, do not send permissions list at all.
+ *
+ *
+ * To add or remove a single permission grant instead of updating the whole list at once use the {schemeId}/permission/ resource.
+ *
+ */
+ updatePermissionScheme: {
+ parameters: {
+ query?: {
+ expand?: string;
+ };
+ path: {
+ schemeId: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Deletes a permission scheme identified by the given id. */
+ deletePermissionScheme: {
+ parameters: {
+ path: {
+ schemeId: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns all permission grants of the given permission scheme. */
+ getPermissionSchemeGrants: {
+ parameters: {
+ query?: {
+ expand?: string;
+ };
+ path: {
+ schemeId: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Creates a permission grant in a permission scheme. */
+ createPermissionGrant: {
+ parameters: {
+ query?: {
+ expand?: string;
+ };
+ path: {
+ schemeId: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns a permission grant identified by the given id. */
+ getPermissionSchemeGrant: {
+ parameters: {
+ query?: {
+ expand?: string;
+ };
+ path: {
+ permissionId: number;
+ schemeId: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Deletes a permission grant from a permission scheme. */
+ deletePermissionSchemeEntity: {
+ parameters: {
+ path: {
+ permissionId: number;
+ schemeId: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns a list of all issue priorities. */
+ getPriorities: {
+ parameters: {
+ query?: {
+ startAt?: number;
+ maxResults?: number;
+ query?: string;
+ projectIds?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns an issue priority. */
+ getPriority: {
+ parameters: {
+ path: {
+ /** @description a String containing the priority id */
+ id: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns all priority schemes.
+ *
+ * All project keys associated with the priority scheme will only be returned if additional query parameter is provided expand=schemes.projectKeys.
+ */
+ getPrioritySchemes: {
+ parameters: {
+ query?: {
+ /** @description the page offset, if not specified then defaults to 0 */
+ startAt?: number;
+ /** @description how many results on the page should be included. Defaults to 100, maximum is 1000. */
+ maxResults?: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Creates new priority scheme. */
+ createPriorityScheme: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Gets a full representation of a priority scheme in JSON format.
+ *
+ * All project keys associated with the priority scheme will only be returned if additional query parameter is provided expand=projectKeys.
+ */
+ getPriorityScheme: {
+ parameters: {
+ path: {
+ /** @description id of priority scheme to get */
+ schemeId: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Updates a priority scheme.
+ * Update will be rejected if issue migration would be needed as a result of scheme update.
+ * Priority scheme update with migration is possible from the UI.
+ *
+ * All project keys associated with the priority scheme will only be returned if additional query parameter is provided expand=projectKeys.
+ */
+ updatePriorityScheme: {
+ parameters: {
+ path: {
+ /** @description id of priority scheme to get */
+ schemeId: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Deletes a priority scheme. All projects using deleted scheme will use default priority scheme afterwards.
+ *
+ * Default priority scheme can't be deleted.
+ */
+ deletePriorityScheme: {
+ parameters: {
+ path: {
+ /** @description id of priority scheme to get */
+ schemeId: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns all projects which are visible for the currently logged in user. If no user is logged in, it returns the
+ * list of projects that are visible when using anonymous access.
+ */
+ getAllProjects: {
+ parameters: {
+ query?: {
+ /** @description the parameters to expand */
+ expand?: string;
+ /** @description if this parameter is set then only projects recently accessed by the current user (if not logged in then based on HTTP session) will be returned (maximum count limited to the specified number but no more than 20). */
+ recent?: number;
+ /** @description whether to include archived projects in response, default: false */
+ includeArchived?: boolean;
+ /** @description whether to include only projects where current user can browse archive */
+ browseArchive?: boolean;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Creates a new project. */
+ createProject: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns all the project types defined on the Jira instance, not taking into account whether
+ * the license to use those project types is valid or not.
+ */
+ getAllProjectTypes: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns the project type with the given key. */
+ getProjectTypeByKey: {
+ parameters: {
+ path: {
+ projectTypeKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns the project type with the given key, if it is accessible to the logged in user.
+ * This takes into account whether the user is licensed on the Application that defines the project type.
+ */
+ getAccessibleProjectTypeByKey: {
+ parameters: {
+ path: {
+ projectTypeKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Validates a project key. */
+ getProject: {
+ parameters: {
+ query?: {
+ /** @description the project key */
+ key?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Updates a project.
+ *
+ * Only non null values sent in JSON will be updated in the project.
+ *
+ * Values available for the assigneeType field are: "PROJECT_LEAD" and "UNASSIGNED".
+ */
+ updateProject: {
+ parameters: {
+ query?: {
+ /** @description the parameters to expand in returned project */
+ expand?: string;
+ };
+ path: {
+ /** @description the project id or project key */
+ projectIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Deletes a project. */
+ deleteProject: {
+ parameters: {
+ path: {
+ /** @description the project id or project key */
+ projectIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Archives a project. */
+ archiveProject: {
+ parameters: {
+ path: {
+ /** @description Project id or project key */
+ projectIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Updates an avatar for a project. This is step 3/3 of changing an avatar for a project:
+ *
+ *
+ * - Upload (store temporary avatar)
+ * - Crop (create avatar from temporary)
+ * - Update (update project avatar)
+ *
+ */
+ updateProjectAvatar: {
+ parameters: {
+ path: {
+ /** @description project id or project key */
+ projectIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Deletes avatar */
+ deleteAvatar: {
+ parameters: {
+ query?: {
+ /** @description username */
+ username?: string;
+ };
+ path: {
+ /** @description database id for avatar */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns all avatars which are visible for the currently logged in user. */
+ getAllAvatars: {
+ parameters: {
+ query?: {
+ /** @description username */
+ username?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Contains a full representation of a the specified project's components. */
+ getProjectComponents: {
+ parameters: {
+ path: {
+ /** @description the project id or project key */
+ projectIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Restore an archived project.
+ * In case of success restored project should be re-indexed.
+ */
+ restoreProject: {
+ parameters: {
+ path: {
+ /** @description Project id or project key */
+ projectIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Get all the ProjectRoles available in Jira. Currently this list is global. */
+ getProjectRoles: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns the details for a given project role in a project. */
+ getProjectRole: {
+ parameters: {
+ path: {
+ /** @description the project id or project key */
+ projectIdOrKey: string;
+ /** @description the project role id */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Updates a project role to include the specified actors (users or groups). Can be also used to clear roles to not include any users or groups.
+ *
+ * For user actors, their usernames should be used.
+ */
+ setActors: {
+ parameters: {
+ path: {
+ /** @description the project id or project key */
+ projectIdOrKey: string;
+ /** @description the project role id */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Adds an actor (user or group) to a project role.
+ *
+ * For user actors, their usernames should be used.
+ */
+ addActorUsers: {
+ parameters: {
+ path: {
+ /** @description the project id or project key */
+ projectIdOrKey: string;
+ /** @description the project role id */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Deletes actors (users or groups) from a project role.
+ *
+ *
+ * - Delete a user from the role:
/rest/api/2/project/{projectIdOrKey}/role/{roleId}?user={username}
+ * - Delete a group from the role:
/rest/api/2/project/{projectIdOrKey}/role/{roleId}?group={groupname}
+ *
+ */
+ deleteActor: {
+ parameters: {
+ query?: {
+ /** @description the username of the user to remove from the project role */
+ user?: string;
+ /** @description the groupname to remove from the project role */
+ group?: string;
+ };
+ path: {
+ /** @description the project id or project key */
+ projectIdOrKey: string;
+ /** @description the project role id */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Get all issue types with valid status values for a project */
+ getAllStatuses: {
+ parameters: {
+ path: {
+ /** @description Project id or project key */
+ projectIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Updates the type of a project. */
+ updateProjectType: {
+ parameters: {
+ path: {
+ /** @description identity of the project to update */
+ projectIdOrKey: string;
+ /** @description The key of the new project type */
+ newProjectTypeKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns all versions for the specified project. Results are paginated.
+ *
+ * Results can be ordered by the following fields:
+ *
+ * - sequence
+ * - name
+ * - startDate
+ * - releaseDate
+ *
+ *
+ */
+ getProjectVersionsPaginated: {
+ parameters: {
+ query?: {
+ /** @description the page offset, if not specified then defaults to 0 */
+ startAt?: number;
+ /** @description how many results on the page should be included. Defaults to 50. */
+ maxResults?: number;
+ /** @description ordering of the results. */
+ orderBy?: string;
+ /** @description the parameters to expand */
+ expand?: string;
+ };
+ path: {
+ /** @description the project id or project key */
+ projectIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Contains a full representation of a the specified project's versions. */
+ getProjectVersions: {
+ parameters: {
+ query?: {
+ /** @description the parameters to expand */
+ expand?: string;
+ };
+ path: {
+ /** @description the project id or project key */
+ projectIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Gets a permission scheme assigned with a project. */
+ getAssignedPermissionScheme: {
+ parameters: {
+ query?: {
+ expand?: string;
+ };
+ path: {
+ /** @description key or id of the project */
+ projectKeyOrId: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Assigns a permission scheme with a project. */
+ assignPermissionScheme: {
+ parameters: {
+ query?: {
+ expand?: string;
+ };
+ path: {
+ /** @description key or id of the project */
+ projectKeyOrId: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Gets a full representation of a priority scheme in JSON format used by specified project.
+ * User must be global administrator or project administrator.
+ *
+ * All project keys associated with the priority scheme will only be returned if additional query parameter is provided expand=projectKeys.
+ */
+ getAssignedPriorityScheme: {
+ parameters: {
+ path: {
+ /** @description key or id of the project */
+ projectKeyOrId: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Assigns project with priority scheme.
+ * Priority scheme assign with migration is possible from the UI.
+ *
+ * Operation will fail if migration is needed as a result of operation eg. there are issues with priorities invalid in the destination scheme.
+ *
+ * All project keys associated with the priority scheme will only be returned if additional query parameter is provided expand=projectKeys.
+ */
+ assignPriorityScheme: {
+ parameters: {
+ path: {
+ /** @description key or id of the project */
+ projectKeyOrId: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Unassigns project from priority scheme.
+ *
+ * Operation will fail for defualt priority scheme, project is not found or project is not associated with provided priority scheme.
+ *
+ * All project keys associated with the priority scheme will only be returned if additional query parameter is provided expand=projectKeys.
+ */
+ unassignPriorityScheme: {
+ parameters: {
+ path: {
+ /** @description key or id of the project */
+ projectKeyOrId: string;
+ /** @description object that contains an id of the scheme */
+ schemeId: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns all security levels for the project that the current logged in user has access to.
+ * If the user does not have the Set Issue Security permission, the list will be empty.
+ */
+ getSecurityLevelsForProject: {
+ parameters: {
+ path: {
+ /** @description - key or id of project to list the security levels for */
+ projectKeyOrId: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns the workflow scheme that is associated with requested project. */
+ getWorkflowSchemeForProject: {
+ parameters: {
+ path: {
+ /** @description the key or id of the project. */
+ projectKeyOrId: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns all project categories */
+ getAllProjectCategories: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Create a project category via POST. */
+ createProjectCategory: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Contains a representation of a project category in JSON format. */
+ getProjectCategoryById: {
+ parameters: {
+ path: {
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Modify a project category via PUT. Any fields present in the PUT will override existing values. As a convenience, if a field
+ * is not present, it is silently ignored.
+ */
+ updateProjectCategory: {
+ parameters: {
+ path: {
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Delete a project category. */
+ removeProjectCategory: {
+ parameters: {
+ path: {
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns a list of projects visible to the user where project name and/or key is matching the given query.
+ *
+ * Passing an empty (or whitespace only) query will match no projects. The project matches will
+ * contain a field with the query highlighted.
+ *
+ * The number of projects returned can be controlled by passing a value for "maxResults", but a hard limit of no
+ * more than 100 projects is enforced. The projects are wrapped in a single response object that contains
+ * a header for use in the picker, specifically Showing X of Y matching projects and the total number
+ * of matches for the query.
+ */
+ searchForProjects: {
+ parameters: {
+ query?: {
+ /** @description a sequence of characters expected to be found in the word-prefix of project name and/or key. */
+ query?: string;
+ /** @description maximum number of matches to return. Zero means a default limit of 100 and negative numbers return no results. */
+ maxResults?: number;
+ /** @description if true, and the query is empty, the method will return first results limited to the value of "maxResults" or default limit of 100. */
+ allowEmptyQuery?: boolean;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns information on the system reindexes. If a reindex is currently taking place then information about this reindex is returned.
+ * If there is no active index task, then returns information about the latest reindex task run, otherwise returns a 404
+ * indicating that no reindex has taken place.
+ */
+ getReindexInfo: {
+ parameters: {
+ query?: {
+ /**
+ * @description the id of an indexing task you wish to obtain details on. If omitted, then defaults to the standard behaviour and
+ * returns information on the active reindex task, or the last task to run if no reindex is taking place. . If there is no
+ * reindexing task with that id then a 404 is returned.
+ */
+ taskId?: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Kicks off a reindex. Need Admin permissions to perform this reindex. */
+ reindex: {
+ parameters: {
+ query?: {
+ /** @description Case insensitive String indicating type of reindex. If omitted, then defaults to BACKGROUND_PREFERRED. */
+ type?: string;
+ /** @description Indicates that comments should also be reindexed. Not relevant for foreground reindex, where comments are always reindexed. */
+ indexComments?: boolean;
+ /** @description Indicates that changeHistory should also be reindexed. Not relevant for foreground reindex, where changeHistory is always reindexed. */
+ indexChangeHistory?: boolean;
+ /** @description Indicates that worklogs should also be reindexed. Not relevant for foreground reindex, where worklogs are always reindexed. */
+ indexWorklogs?: boolean;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Reindexes one or more individual issues. Indexing is performed synchronously - the call returns when indexing of
+ * the issues has completed or a failure occurs.
+ *
+ * Use either explicitly specified issue IDs or a JQL query to select issues to reindex.
+ */
+ reindexIssues: {
+ parameters: {
+ query?: {
+ /** @description the IDs or keys of one or more issues to reindex. */
+ issueId?: string;
+ /** @description Indicates that comments should also be reindexed. */
+ indexComments?: boolean;
+ /** @description Indicates that changeHistory should also be reindexed. */
+ indexChangeHistory?: boolean;
+ /** @description Indicates that worklogs should also be reindexed. */
+ indexWorklogs?: boolean;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns information on the system reindexes. If a reindex is currently taking place then information about this reindex is returned.
+ * If there is no active index task, then returns information about the latest reindex task run, otherwise returns a 404
+ * indicating that no reindex has taken place.
+ */
+ getReindexProgress: {
+ parameters: {
+ query?: {
+ /**
+ * @description the id of an indexing task you wish to obtain details on. If omitted, then defaults to the standard behaviour and
+ * returns information on the active reindex task, or the last task to run if no reindex is taking place. . If there is no
+ * reindexing task with that id then a 404 is returned.
+ */
+ taskId?: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Executes any pending reindex requests. Returns a JSON array containing the IDs of the reindex requests
+ * that are being processed. Execution is asynchronous - progress of the returned tasks can be monitored through
+ * other REST calls.
+ */
+ processRequests: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Retrieves the progress of a multiple reindex requests. Only reindex requests that actually exist will be returned
+ * in the results.
+ */
+ getProgressBulk: {
+ parameters: {
+ query?: {
+ /** @description the reindex request IDs. */
+ requestId?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns information about a user anonymization operation progress. */
+ getProgress: {
+ parameters: {
+ query?: {
+ /**
+ * @description the id of a user anonymization task you wish to obtain details on. If omitted, then defaults to
+ * the active anonymization task, or the last task that was run if no anonymization is taking place.
+ */
+ taskId?: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns a list of all resolutions. */
+ getResolutions: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns paginated list of filtered resolutions */
+ getPaginatedResolutions: {
+ parameters: {
+ query?: {
+ /** @description the index of the first status to return */
+ startAt?: number;
+ /** @description the maximum number of statuses to return */
+ maxResults?: number;
+ /** @description the string that status names will be matched with */
+ query?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns a resolution. */
+ getResolution: {
+ parameters: {
+ path: {
+ /** @description a String containing the resolution id */
+ id: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Creates a new ProjectRole to be available in Jira.
+ * The created role does not have any default actors assigned.
+ */
+ createProjectRole: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Get a specific ProjectRole available in Jira. */
+ getProjectRolesById: {
+ parameters: {
+ path: {
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Fully updates a roles. Both name and description must be given. */
+ fullyUpdateProjectRole: {
+ parameters: {
+ path: {
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Partially updates a roles name or description. */
+ partialUpdateProjectRole: {
+ parameters: {
+ path: {
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Deletes a role. May return 403 in the future */
+ deleteProjectRole: {
+ parameters: {
+ query?: {
+ /** @description if given, removes a role even if it is used in scheme by replacing the role with the given one */
+ swap?: number;
+ };
+ path: {
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Gets default actors for the given role. */
+ getProjectRoleActorsForRole: {
+ parameters: {
+ path: {
+ /** @description the role id to remove the actors from */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Adds default actors to the given role. The request data should contain a list of usernames or a list of groups to add. */
+ addProjectRoleActorsToRole: {
+ parameters: {
+ path: {
+ /** @description the role id to remove the actors from */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Removes default actor from the given role. */
+ deleteProjectRoleActorsFromRole: {
+ parameters: {
+ query?: {
+ /** @description if given, removes an actor from given role */
+ user?: string;
+ /** @description if given, removes an actor from given role */
+ group?: string;
+ };
+ path: {
+ /** @description the role id to remove the actors from */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Gets available field screens */
+ getAllScreens: {
+ parameters: {
+ query?: {
+ /** @description offset from which the response starts */
+ startAt?: string;
+ /** @description amount of field screens to return */
+ maxResults?: string;
+ expand?: string;
+ search?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Adds field or custom field to the default tab */
+ addFieldToDefaultScreen: {
+ parameters: {
+ path: {
+ /** @description id of field / custom field */
+ fieldId: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Gets available fields for screen. i.e ones that haven't already been added. */
+ getFieldsToAdd: {
+ parameters: {
+ path: {
+ /** @description id of screen */
+ screenId: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns a list of all tabs for the given screen */
+ getAllTabs: {
+ parameters: {
+ query?: {
+ /** @description the key of the project; this parameter is optional */
+ projectKey?: string;
+ };
+ path: {
+ /** @description id of screen */
+ screenId: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Creates tab for given screen */
+ addTab: {
+ parameters: {
+ path: {
+ /** @description id of screen */
+ screenId: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Renames tab on given screen */
+ renameTab: {
+ parameters: {
+ path: {
+ /** @description id of screen */
+ screenId: number;
+ /** @description id of tab */
+ tabId: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Deletes tab to give screen */
+ deleteTab: {
+ parameters: {
+ path: {
+ /** @description id of screen */
+ screenId: number;
+ /** @description id of tab */
+ tabId: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Gets all fields for a given tab */
+ getAllFields: {
+ parameters: {
+ query?: {
+ /** @description the key of the project; this parameter is optional */
+ projectKey?: string;
+ };
+ path: {
+ /** @description id of screen */
+ screenId: number;
+ /** @description id of tab */
+ tabId: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Adds field to the given tab. */
+ addField: {
+ parameters: {
+ path: {
+ /** @description id of screen */
+ screenId: number;
+ /** @description id of tab */
+ tabId: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Removes field from given tab */
+ removeField: {
+ parameters: {
+ path: {
+ /** @description id of screen */
+ screenId: number;
+ /** @description id of tab */
+ tabId: number;
+ id: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Moves field on the given tab */
+ moveField: {
+ parameters: {
+ path: {
+ /** @description id of screen */
+ screenId: number;
+ /** @description id of tab */
+ tabId: number;
+ id: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Update 'showWhenEmptyIndicator' for given field on screen */
+ updateShowWhenEmptyIndicator: {
+ parameters: {
+ path: {
+ /** @description id of screen */
+ screenId: number;
+ /** @description id of tab */
+ tabId: number;
+ /** @description new value of 'showWhenEmptyIndicator' */
+ newValue: boolean;
+ /** @description id of field */
+ id: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Moves tab position */
+ moveTab: {
+ parameters: {
+ path: {
+ /** @description id of screen */
+ screenId: number;
+ /** @description id of tab */
+ tabId: number;
+ /** @description position of tab */
+ pos: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Searches for issues using JQL.
+ *
+ * Sorting
+ * the jql parameter is a full JQL
+ * expression, and includes an ORDER BY clause.
+ *
+ *
+ * The fields param (which can be specified multiple times) gives a comma-separated list of fields
+ * to include in the response. This can be used to retrieve a subset of fields.
+ * A particular field can be excluded by prefixing it with a minus.
+ *
+ * By default, only navigable (*navigable) fields are returned in this search resource. Note: the default is different
+ * in the get-issue resource -- the default there all fields (*all).
+ *
+ * *all - include all fields*navigable - include just navigable fieldssummary,comment - include just the summary and comments-description - include navigable fields except the description (the default is *navigable for search)*all,-comment - include everything except comments
+ *
+ *
+ * GET vs POST:
+ * If the JQL query is too large to be encoded as a query param you should instead
+ * POST to this resource.
+ *
+ *
+ * Expanding Issues in the Search Result:
+ * It is possible to expand the issues returned by directly specifying the expansion on the expand parameter passed
+ * in to this resources.
+ *
+ *
+ * For instance, to expand the "changelog" for all the issues on the search result, it is neccesary to
+ * specify "changelog" as one of the values to expand.
+ *
+ */
+ search: {
+ parameters: {
+ query?: {
+ /** @description a JQL query string */
+ jql?: string;
+ /** @description the index of the first issue to return (0-based) */
+ startAt?: number;
+ /**
+ * @description the maximum number of issues to return (defaults to 50). The maximum allowable value is
+ * dictated by the Jira property 'jira.search.views.default.max'. If you specify a value that is higher than this
+ * number, your search results will be truncated.
+ */
+ maxResults?: number;
+ /** @description whether to validate the JQL query */
+ validateQuery?: boolean;
+ /** @description the list of fields to return for each issue. By default, all navigable fields are returned. */
+ fields?: string;
+ /** @description A comma-separated list of the parameters to expand. */
+ expand?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Performs a search using JQL. */
+ searchUsingSearchRequest: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns a full representation of the security level that has the given id. */
+ getIssuesecuritylevel: {
+ parameters: {
+ path: {
+ /** @description a String containing an issue security level id */
+ id: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns general information about the current Jira server. */
+ getServerInfo: {
+ parameters: {
+ query?: {
+ doHealthCheck?: boolean;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Sets the base URL that is configured for this Jira instance. */
+ setBaseURL: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns the default system columns for issue navigator. Admin permission will be required. */
+ getIssueNavigatorDefaultColumns: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Sets the default system columns for issue navigator. Admin permission will be required. */
+ setIssueNavigatorDefaultColumns: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns a list of all statuses */
+ getStatuses: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns paginated list of filtered statuses */
+ getPaginatedStatuses: {
+ parameters: {
+ query?: {
+ /** @description the index of the first status to return */
+ startAt?: number;
+ /** @description the maximum number of statuses to return */
+ maxResults?: number;
+ /** @description the string that status names will be matched with */
+ query?: string;
+ /** @description the list of project ids to filter statuses */
+ projectIds?: string;
+ /** @description the list of issue type ids to filter statuses */
+ issueTypeIds?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns a full representation of the Status having the given id or name. */
+ getStatus: {
+ parameters: {
+ path: {
+ /** @description a numeric Status id or a status name */
+ idOrName: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns a list of all status categories */
+ getStatusCategories: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns a full representation of the StatusCategory having the given id or key */
+ getStatusCategory: {
+ parameters: {
+ path: {
+ /** @description a numeric StatusCategory id or a status category key */
+ idOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns the list of all defined names for the default words "epic" and "sprint". */
+ getAllTerminologyEntries: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Change epic/sprint names from {"originalName"} to {"newName"}. The {"newName"} will be displayed in Jira instead of {"originalName"}.
+ *
+ * {"originalName"} must be equal to "epic" or "sprint".
+ * There can be only one entry per unique {"originalName"}.
+ *
+ * {"newName"} can only consist of alphanumeric characters and spaces e.g. {"newName": "iteration number 2"}.
+ *
+ * {"newName"} must be between 1 to 100 characters.
+ * It can't use the already defined {"newName"} values or restricted JQL words .
+ *
+ * To reset {"newName"} to the default value, enter the {"originalName"} value as the value for {"newName"}. For example, if you want to return to {"originalName": "sprint"}, enter {"newName": "sprint"}.
+ */
+ setTerminologyEntries: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns epic or sprint name as specified in the {originalName} path param. */
+ getTerminologyEntry: {
+ parameters: {
+ path: {
+ originalName: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ getAvatars: {
+ parameters: {
+ path: {
+ type: string;
+ owningObjectId: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns the result of the last upgrade task.
+ *
+ * Returns {@link javax.ws.rs.core.Response#seeOther(java.net.URI)} if still running.
+ */
+ getUpgradeResult: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Runs any pending delayed upgrade tasks. Need Admin permissions to do this. */
+ runUpgradesNow: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Create user. By default created user will not be notified with email.
+ * If password field is not set then password will be randomly generated.
+ */
+ createUser: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Removes user and its references (like project roles associations, watches, history).
+ *
+ *
+ * Note: user references will not be removed if multiple User Directories are used and there is a user with
+ * the same name existing in another directory (shadowing user).
+ */
+ removeUser: {
+ parameters: {
+ query?: {
+ /** @description the username */
+ username?: string;
+ /** @description user key */
+ key?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns available accessibility personal settings along with `enabled` property
+ * that indicates the currently logged-in user preference.
+ */
+ getA11yPersonalSettings: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Validates user anonymization process. */
+ validateUserAnonymization: {
+ parameters: {
+ query?: {
+ /** @description the key of the user to validate anonymization for. */
+ userKey?: string;
+ /** @description Parameter used to include parts of the response. This can be used to include: affectedEntities. Affected entities will only be returned if expand=affectedEntities. */
+ expand?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Schedules a user anonymization process. Requires system admin permission. */
+ scheduleUserAnonymization: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Validates user anonymization re-run process. */
+ validateUserAnonymizationRerun: {
+ parameters: {
+ query?: {
+ /** @description the key of the user to validate anonymization for */
+ userKey?: string;
+ /**
+ * @description user key before anonymization, only needed when current value is anonymized.
+ * If there is no old key, e.g. because the user was already created
+ * using the new key generation strategy, provide a value equal to the current key.
+ */
+ oldUserKey?: string;
+ /**
+ * @description user name before anonymization, only needed when the current value is anonymized.
+ * If there is no old name, provide a value equal to the current name.
+ */
+ oldUserName?: string;
+ /** @description Parameter used to include parts of the response. This can be used to include: affectedEntities. Affected entities will only be returned if expand=affectedEntities. */
+ expand?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Schedules a user anonymization process. Requires system admin permission. */
+ scheduleUserAnonymizationRerun: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Removes stale user anonymization task, for scenarios when the node that was executing it is no longer alive.
+ *
+ * Use it only after making sure that the parent node of the task is actually down, and not just having
+ * connectivity issues.
+ */
+ unlockAnonymization: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Add user to given application. Admin permission will be required to perform this operation. */
+ addUserToApplication: {
+ parameters: {
+ query?: {
+ /** @description username */
+ username?: string;
+ /** @description application key */
+ applicationKey?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Remove user from given application. Admin permission will be required to perform this operation. */
+ removeUserFromApplication: {
+ parameters: {
+ query?: {
+ /** @description username */
+ username?: string;
+ /** @description application key */
+ applicationKey?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns a list of users that match the search string and can be assigned issues for all the given projects. */
+ findBulkAssignableUsers: {
+ parameters: {
+ query?: {
+ /** @description the username */
+ username?: string;
+ /** @description the keys of the projects we are finding assignable users for, comma-separated */
+ projectKeys?: string;
+ /**
+ * @description the maximum number of users to return (defaults to 50). The maximum allowed value is 100.
+ * If you specify a value that is higher than this number, your search results will be truncated.
+ */
+ maxResults?: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns a list of users that match the search string. This resource cannot be accessed anonymously.
+ * Please note that this resource should be called with an issue key when a list of assignable users is retrieved
+ * for editing. For create only a project key should be supplied. The list of assignable users may be incorrect
+ * if it's called with the project key for editing.
+ */
+ findAssignableUsers: {
+ parameters: {
+ query?: {
+ /** @description the username */
+ username?: string;
+ /** @description the key of the project we are finding assignable users for */
+ project?: string;
+ /** @description the issue key for the issue being edited we need to find assignable users for. */
+ issueKey?: string;
+ /**
+ * @description the maximum number of users to return (defaults to 50). The maximum allowed value is 100.
+ * If you specify a value that is higher than this number, your search results will be truncated.
+ */
+ maxResults?: number;
+ actionDescriptorId?: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ updateUserAvatar: {
+ parameters: {
+ query?: {
+ username?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns the number of users whose accounts are duplicated.
+ * Duplicated means that the user has an account in more than one directory
+ * and either more than one account is active or the only active account does not belong to the directory
+ * with the highest priority.
+ * The data returned by this endpoint is cached for 10 minutes and the cache is flushed when any User Directory
+ * is added, removed, enabled, disabled, or synchronized.
+ * A System Administrator can also flush the cache manually.
+ * Related JAC ticket: https://jira.atlassian.com/browse/JRASERVER-68797
+ */
+ getDuplicatedUsersCount: {
+ parameters: {
+ query?: {
+ /** @description if set to true forces cache flush, user must be sysadmin for this parameter to have an effect. */
+ flush?: boolean;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns duplicated users mapped to their directories with an indication if their accounts are active or not.
+ * Duplicated means that the user has an account in more than one directory and either more than one account is active
+ * or the only active account does not belong to the directory with the highest priority.
+ * The data returned by this endpoint is cached for 10 minutes and the cache is flushed when any User Directory
+ * is added, removed, enabled, disabled, or synchronized.
+ * A System Administrator can also flush the cache manually.
+ * Related JAC ticket: https://jira.atlassian.com/browse/JRASERVER-68797
+ */
+ getDuplicatedUsersMapping: {
+ parameters: {
+ query?: {
+ /** @description if set to true forces cache flush, user must be sysadmin for this parameter to have an effect. */
+ flush?: boolean;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Modify user password. */
+ changeUserPassword: {
+ parameters: {
+ query?: {
+ /** @description the username */
+ username?: string;
+ /** @description user key */
+ key?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns a list of active users that match the search string and have all specified permissions for the project or issue.
+ * This resource can be accessed by users with ADMINISTER_PROJECT permission for the project or global ADMIN or SYSADMIN rights.
+ * This endpoint can cause serious performance issues and will be removed in Jira 9.0.
+ */
+ findUsersWithAllPermissions: {
+ parameters: {
+ query?: {
+ /** @description the username filter, list includes all users if unspecified */
+ username?: string;
+ /**
+ * @description comma separated list of permissions for project or issue returned users must have, see
+ * Permissions
+ * JavaDoc for the list of all possible permissions.
+ */
+ permissions?: string;
+ /** @description the issue key for the issue for which returned users have specified permissions. */
+ issueKey?: string;
+ /** @description the optional project key to search for users with if no issueKey is supplied. */
+ projectKey?: string;
+ /** @description the index of the first user to return (0-based) */
+ startAt?: number;
+ /**
+ * @description the maximum number of users to return (defaults to 50). The maximum allowed value is 1000.
+ * If you specify a value that is higher than this number, your search results will be truncated.
+ */
+ maxResults?: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns a list of users matching query with highlighting. */
+ findUsersForPicker: {
+ parameters: {
+ query?: {
+ /** @description A string used to search username, Name or e-mail address */
+ query?: string;
+ /**
+ * @description the maximum number of users to return (defaults to 50). The maximum allowed value is 1000.
+ * If you specify a value that is higher than this number, your search results will be truncated.
+ */
+ maxResults?: number;
+ showAvatar?: boolean;
+ exclude?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns a list of users that match the search string. This resource cannot be accessed anonymously. */
+ findUsers: {
+ parameters: {
+ query?: {
+ /** @description A query string used to search username, name or e-mail address */
+ username?: string;
+ /** @description the index of the first user to return (0-based) */
+ startAt?: number;
+ /**
+ * @description the maximum number of users to return (defaults to 50). The maximum allowed value is 1000.
+ * If you specify a value that is higher than this number, your search results will be truncated.
+ */
+ maxResults?: number;
+ /** @description If true, then active users are included in the results (default true) */
+ includeActive?: boolean;
+ /** @description If true, then inactive users are included in the results (default false) */
+ includeInactive?: boolean;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ deleteSession: {
+ parameters: {
+ path: {
+ username: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns a list of active users that match the search string. This resource cannot be accessed anonymously
+ * and requires the Browse Users global permission.
+ * Given an issue key this resource will provide a list of users that match the search string and have
+ * the browse issue permission for the issue provided.
+ */
+ findUsersWithBrowsePermission: {
+ parameters: {
+ query?: {
+ /** @description the username filter, no users returned if left blank */
+ username?: string;
+ /** @description the issue key for the issue being edited we need to find viewable users for. */
+ issueKey?: string;
+ /** @description the optional project key to search for users with if no issueKey is supplied. */
+ projectKey?: string;
+ /**
+ * @description the maximum number of users to return (defaults to 50). The maximum allowed value is 100.
+ * If you specify a value that is higher than this number, your search results will be truncated.
+ */
+ maxResults?: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Retrieve paginated collection of versions matching given query optionally filtered by given project IDs. */
+ getPaginatedVersions: {
+ parameters: {
+ query?: {
+ /** @description optional index of the first version to return */
+ startAt?: number;
+ /** @description optional maximum number of versions to return */
+ maxResults?: number;
+ /** @description optional string that version names will be matched with */
+ query?: string;
+ /** @description optional set of project IDs to filter versions with */
+ projectIds?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Create a version via POST. */
+ createVersion: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns the remote version links for a given global ID. */
+ getRemoteVersionLinks: {
+ parameters: {
+ query?: {
+ /** @description the global ID of the remote resource that is linked to the versions */
+ globalId?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns a project version. */
+ getVersion: {
+ parameters: {
+ query?: {
+ expand?: string;
+ };
+ path: {
+ /** @description The version to delete */
+ id: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Modify a version via PUT. Any fields present in the PUT will override existing values. As a convenience, if a field
+ * is not present, it is silently ignored.
+ */
+ updateVersion: {
+ parameters: {
+ path: {
+ /** @description The version to delete */
+ id: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Merge versions */
+ merge: {
+ parameters: {
+ path: {
+ /**
+ * @description The version to set fixVersion to on issues where the deleted version is the fix version,
+ * If null then the fixVersion is removed.
+ */
+ moveIssuesTo: string;
+ /** @description The version that will be merged to version {@code moveIssuesTo} and removed */
+ id: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Modify a version's sequence within a project.
+ *
+ * The move version bean has 2 alternative field value pairs:
+ *
+ * - position
- An absolute position, which may have a value of 'First', 'Last', 'Earlier' or 'Later'
+ * - after
- A version to place this version after. The value should be the self link of another version
+ *
+ */
+ moveVersion: {
+ parameters: {
+ path: {
+ /** @description a String containing the version id */
+ id: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns a bean containing the number of fixed in and affected issues for the given version. */
+ getVersionRelatedIssues: {
+ parameters: {
+ path: {
+ /** @description a String containing the version id */
+ id: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns the number of unresolved issues for the given version */
+ getVersionUnresolvedIssues: {
+ parameters: {
+ path: {
+ /** @description a String containing the version id */
+ id: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns the remote version links associated with the given version ID. */
+ getRemoteVersionLinksByVersionId: {
+ parameters: {
+ path: {
+ /** @description The version for which to delete ALL existing remote version links */
+ versionId: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Create a remote version link via POST. The link's global ID will be taken from the
+ * JSON payload if provided; otherwise, it will be generated.
+ */
+ createOrUpdateRemoteVersionLink: {
+ parameters: {
+ path: {
+ /** @description The version ID of the remote link */
+ versionId: string;
+ /** @description The global ID of the remote link */
+ globalId: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Delete all remote version links for a given version ID. */
+ deleteRemoteVersionLinksByVersionId: {
+ parameters: {
+ path: {
+ /** @description The version for which to delete ALL existing remote version links */
+ versionId: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description A REST sub-resource representing a remote version link */
+ getRemoteVersionLink: {
+ parameters: {
+ path: {
+ /** @description The version ID of the remote link */
+ versionId: string;
+ /** @description The global ID of the remote link */
+ globalId: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Delete a specific remote version link with the given version ID and global ID. */
+ deleteRemoteVersionLink: {
+ parameters: {
+ path: {
+ /** @description The version ID of the remote link */
+ versionId: string;
+ /** @description The global ID of the remote link */
+ globalId: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns all workflows. The “lastModifiedDate” is returned in Jira Complete Date/Time Format (dd/MMM/yy h:mm by default),
+ * but can also be returned as a relative date.
+ */
+ getAllWorkflows: {
+ parameters: {
+ query?: {
+ workflowName?: string;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Return the property or properties associated with a transition. */
+ getProperties: {
+ parameters: {
+ query?: {
+ /**
+ * @description some keys under the "jira." prefix are editable, some are not. Set this to true
+ * in order to include the non-editable keys in the response.
+ */
+ includeReservedKeys?: boolean;
+ /** @description the name of the property key to query. Can be left off the query to return all properties. */
+ key?: string;
+ /** @description the name of the workflow to use. */
+ workflowName?: string;
+ /** @description the type of workflow to use. Can either be "live" or "draft". */
+ workflowMode?: string;
+ };
+ path: {
+ /** @description the ID of the transition within the workflow. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Update/add new property to a transition. Trying to update a property that does
+ * not exist will result in a new property being added.
+ */
+ updateProperty: {
+ parameters: {
+ query?: {
+ /** @description the name of the property to add. */
+ key?: string;
+ /** @description the name of the workflow to use. */
+ workflowName?: string;
+ /** @description the type of workflow to use. Can either be "live" or "draft". */
+ workflowMode?: string;
+ };
+ path: {
+ /** @description the ID of the transition within the workflow. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Add a new property to a transition. Trying to add a property that already
+ * exists will fail.
+ */
+ createProperty: {
+ parameters: {
+ query?: {
+ /** @description the name of the property to add. */
+ key?: string;
+ /** @description the name of the workflow to use. */
+ workflowName?: string;
+ /** @description the type of workflow to use. Can either be "live" or "draft". */
+ workflowMode?: string;
+ };
+ path: {
+ /** @description the ID of the transition within the workflow. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Create a new workflow scheme.
+ *
+ * The body contains a representation of the new scheme. Values not passed are assumed to be set to their defaults.
+ */
+ createScheme: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns the requested workflow scheme to the caller. */
+ getById: {
+ parameters: {
+ query?: {
+ /**
+ * @description when true indicates that a scheme's draft, if it exists, should be queried instead of
+ * the scheme itself.
+ */
+ returnDraftIfExists?: boolean;
+ };
+ path: {
+ /** @description the id of the scheme. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Update the passed workflow scheme.
+ *
+ * The body of the request is a representation of the workflow scheme. Values not passed are assumed to indicate
+ * no change for that field.
+ *
+ * The passed representation can have its updateDraftIfNeeded flag set to true to indicate that the draft
+ * should be created and/or updated when the actual scheme cannot be edited (e.g. when the scheme is being used by
+ * a project). Values not appearing the body will not be touched.
+ */
+ update: {
+ parameters: {
+ path: {
+ /** @description the id of the scheme. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Delete the passed workflow scheme. */
+ deleteScheme: {
+ parameters: {
+ path: {
+ /** @description the id of the scheme. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Create a draft for the passed scheme. The draft will be a copy of the state of the parent. */
+ createDraftForParent: {
+ parameters: {
+ path: {
+ /** @description the id of the parent scheme. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Return the default workflow from the passed workflow scheme. */
+ getDefault: {
+ parameters: {
+ query?: {
+ /**
+ * @description when true indicates that a scheme's draft, if it exists, should be queried instead of
+ * the scheme itself.
+ */
+ returnDraftIfExists?: boolean;
+ };
+ path: {
+ /** @description the id of the scheme. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Set the default workflow for the passed workflow scheme.
+ *
+ * The passed representation can have its
+ * updateDraftIfNeeded flag set to true to indicate that the draft should be created/updated when the actual scheme
+ * cannot be edited.
+ */
+ updateDefault: {
+ parameters: {
+ path: {
+ /** @description the id of the scheme. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Remove the default workflow from the passed workflow scheme. */
+ deleteDefault: {
+ parameters: {
+ query?: {
+ /**
+ * @description when true will create and return a draft when the workflow scheme cannot be edited
+ * (e.g. when it is being used by a project).
+ */
+ updateDraftIfNeeded?: boolean;
+ };
+ path: {
+ /** @description the id of the scheme. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns the requested draft workflow scheme to the caller. */
+ getDraftById: {
+ parameters: {
+ path: {
+ /** @description the id of the parent scheme. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Update a draft workflow scheme. The draft will created if necessary.
+ *
+ * The body is a representation of the workflow scheme. Values not passed are assumed to indicate no change for that field.
+ */
+ updateDraft: {
+ parameters: {
+ path: {
+ /** @description the id of the parent scheme. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Delete the passed draft workflow scheme. */
+ deleteDraftById: {
+ parameters: {
+ path: {
+ /** @description the id of the parent scheme. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Return the default workflow from the passed draft workflow scheme to the caller. */
+ getDraftDefault: {
+ parameters: {
+ path: {
+ /** @description the id of the parent scheme. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Set the default workflow for the passed draft workflow scheme. */
+ updateDraftDefault: {
+ parameters: {
+ path: {
+ /** @description the id of the parent scheme. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Remove the default workflow from the passed draft workflow scheme. */
+ deleteDraftDefault: {
+ parameters: {
+ path: {
+ /** @description the id of the parent scheme. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns the issue type mapping for the passed draft workflow scheme. */
+ getDraftIssueType: {
+ parameters: {
+ path: {
+ /** @description the issue type being set. */
+ issueType: string;
+ /** @description the id of the parent scheme. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Set the issue type mapping for the passed draft scheme.
+ *
+ * The passed representation can have its updateDraftIfNeeded flag set to true to indicate that
+ * the draft should be created/updated when the actual scheme cannot be edited.
+ */
+ setDraftIssueType: {
+ parameters: {
+ path: {
+ /** @description the issue type being set. */
+ issueType: string;
+ /** @description the id of the parent scheme. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Remove the specified issue type mapping from the draft scheme. */
+ deleteDraftIssueType: {
+ parameters: {
+ path: {
+ /** @description the issue type being set. */
+ issueType: string;
+ /** @description the id of the parent scheme. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns the draft workflow mappings or requested mapping to the caller. */
+ getDraftWorkflow: {
+ parameters: {
+ query?: {
+ /** @description the workflow mapping to return. Null can be passed to return all mappings. Must be a valid workflow name. */
+ workflowName?: string;
+ };
+ path: {
+ /** @description the id of the parent scheme. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Update the draft scheme to include the passed mapping.
+ *
+ * The body is a representation of the workflow mapping.
+ * Values not passed are assumed to indicate no change for that field.
+ */
+ updateDraftWorkflowMapping: {
+ parameters: {
+ query?: {
+ /** @description the name of the workflow mapping to update. */
+ workflowName?: string;
+ };
+ path: {
+ /** @description the id of the parent scheme. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Delete the passed workflow from the draft workflow scheme. */
+ deleteDraftWorkflowMapping: {
+ parameters: {
+ query?: {
+ /** @description the name of the workflow to delete. */
+ workflowName?: string;
+ };
+ path: {
+ /** @description the id of the parent scheme. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Set the issue type mapping for the passed scheme.
+ *
+ * The passed representation can have its updateDraftIfNeeded flag set to true to indicate that
+ * the draft should be created/updated when the actual scheme cannot be edited.
+ */
+ setIssueType: {
+ parameters: {
+ path: {
+ /** @description the issue type being set. */
+ issueType: string;
+ /** @description the id of the scheme. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Returns the workflow mappings or requested mapping to the caller for the passed scheme. */
+ getWorkflow: {
+ parameters: {
+ query?: {
+ /** @description the workflow mapping to return. Null can be passed to return all mappings. Must be a valid workflow name. */
+ workflowName?: string;
+ /**
+ * @description when true indicates that a scheme's draft, if it exists, should be queried instead of
+ * the scheme itself.
+ */
+ returnDraftIfExists?: boolean;
+ };
+ path: {
+ /** @description the id of the scheme. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Update the scheme to include the passed mapping.
+ *
+ * The body is a representation of the workflow mapping.
+ * Values not passed are assumed to indicate no change for that field.
+ *
+ * The passed representation can have its updateDraftIfNeeded flag set to true to indicate that the draft
+ * should be created/updated when the actual scheme cannot be edited.
+ */
+ updateWorkflowMapping: {
+ parameters: {
+ query?: {
+ /** @description the name of the workflow mapping to update. */
+ workflowName?: string;
+ };
+ path: {
+ /** @description the id of the scheme. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Delete the passed workflow from the workflow scheme. */
+ deleteWorkflowMapping: {
+ parameters: {
+ query?: {
+ /** @description the name of the workflow to delete. */
+ workflowName?: string;
+ /**
+ * @description flag to indicate if a draft should be created if necessary to delete the workflow
+ * from the scheme.
+ */
+ updateDraftIfNeeded?: boolean;
+ };
+ path: {
+ /** @description the id of the scheme. */
+ id: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns worklogs id and delete time of worklogs that was deleted since given time.
+ * The returns set of worklogs is limited to 1000 elements.
+ * This API will not return worklogs deleted during last minute.
+ */
+ getIdsOfWorklogsDeletedSince: {
+ parameters: {
+ query?: {
+ /** @description a date time in unix timestamp format since when deleted worklogs will be returned. */
+ since?: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns worklogs for given worklog ids. Only worklogs to which the calling user has permissions, will be included in the result.
+ * The returns set of worklogs is limited to 1000 elements.
+ */
+ getWorklogsForIds: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns worklogs id and update time of worklogs that was updated since given time.
+ * The returns set of worklogs is limited to 1000 elements.
+ * This API will not return worklogs updated during last minute.
+ */
+ getIdsOfWorklogsModifiedSince: {
+ parameters: {
+ query?: {
+ /** @description a date time in unix timestamp format since when updated worklogs will be returned. */
+ since?: number;
+ };
+ };
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Returns information about the currently authenticated user's session. If the caller is not authenticated they
+ * will get a 401 Unauthorized status code.
+ */
+ currentUser: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * @description Creates a new session for a user in Jira. Once a session has been successfully created it can be used to access
+ * any of Jira's remote APIs and also the web UI by passing the appropriate HTTP Cookie header.
+ *
+ * Note that it is generally preferrable to use HTTP BASIC authentication with the REST API. However, this resource
+ * may be used to mimic the behaviour of Jira's log-in page (e.g. to display log-in errors to a user).
+ */
+ login: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description Logs the current user out of Jira, destroying the existing session, if any. */
+ logout: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+ /** @description This method invalidates the any current WebSudo session. */
+ release: {
+ responses: {
+ /** @description Successful Response */
+ 200: {
+ content: never;
+ };
+ };
+ };
+}
diff --git a/src/generated/openapi-service-desk.ts b/src/generated/openapi-service-desk.ts
new file mode 100644
index 0000000..c4cf5f0
--- /dev/null
+++ b/src/generated/openapi-service-desk.ts
@@ -0,0 +1,5737 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+export interface paths {
+ "/rest/servicedeskapi/assets/workspace": {
+ /**
+ * Get assets workspaces
+ * @description Returns a list of Assets workspace IDs. Include a workspace ID in the path to access the [Assets REST APIs](https://developer.atlassian.com/cloud/assets/rest).
+ *
+ * **[Permissions](#permissions) required**: Any
+ */
+ get: operations["getAssetsWorkspaces"];
+ };
+ "/rest/servicedeskapi/customer": {
+ /**
+ * Create customer
+ * @description This method adds a customer to the Jira Service Management instance by passing a JSON file including an email address and display name. The display name does not need to be unique. The record's identifiers, `name` and `key`, are automatically generated from the request details.
+ *
+ * **[Permissions](#permissions) required**: Jira Administrator Global permission
+ */
+ post: operations["createCustomer"];
+ };
+ "/rest/servicedeskapi/info": {
+ /**
+ * Get info
+ * @description This method retrieves information about the Jira Service Management instance such as software version, builds, and related links.
+ *
+ * **[Permissions](#permissions) required**: None, the user does not need to be logged in.
+ */
+ get: operations["getInfo"];
+ };
+ "/rest/servicedeskapi/insight/workspace": {
+ /**
+ * Get insight workspaces
+ * @description This endpoint is deprecated, please use /assets/workspace/.
+ */
+ get: operations["getInsightWorkspaces"];
+ };
+ "/rest/servicedeskapi/knowledgebase/article": {
+ /**
+ * Get articles
+ * @description Returns articles which match the given query string across all service desks.
+ *
+ * **[Permissions](#permissions) required**: Permission to access the [customer portal](https://confluence.atlassian.com/servicedeskcloud/configuring-the-customer-portal-732528918.html).
+ */
+ get: operations["getArticles"];
+ };
+ "/rest/servicedeskapi/organization": {
+ /**
+ * Get organizations
+ * @description This method returns a list of organizations in the Jira Service Management instance. Use this method when you want to present a list of organizations or want to locate an organization by name.
+ *
+ * **[Permissions](#permissions) required**: Any. However, to fetch organizations based on `accountId` the user must have a Service Desk agent license.
+ *
+ * **Response limitations**: If the user is a customer, only those organizations of which the customer is a member are listed.
+ */
+ get: operations["getOrganizations"];
+ /**
+ * Create organization
+ * @description This method creates an organization by passing the name of the organization.
+ *
+ * **[Permissions](#permissions) required**: Service desk administrator or agent. Note: Permission to create organizations can be switched to users with the Jira administrator permission, using the **[Organization management](https://confluence.atlassian.com/servicedeskcloud/setting-up-service-desk-users-732528877.html#Settingupservicedeskusers-manageorgsManageorganizations)** feature.
+ */
+ post: operations["createOrganization"];
+ };
+ "/rest/servicedeskapi/organization/{organizationId}": {
+ /**
+ * Get organization
+ * @description This method returns details of an organization. Use this method to get organization details whenever your application component is passed an organization ID but needs to display other organization details.
+ *
+ * **[Permissions](#permissions) required**: Any
+ *
+ * **Response limitations**: Customers can only retrieve organization of which they are members.
+ */
+ get: operations["getOrganization"];
+ /**
+ * Delete organization
+ * @description This method deletes an organization. Note that the organization is deleted regardless of other associations it may have. For example, associations with service desks.
+ *
+ * **[Permissions](#permissions) required**: Jira administrator.
+ */
+ delete: operations["deleteOrganization"];
+ };
+ "/rest/servicedeskapi/organization/{organizationId}/property": {
+ /**
+ * Get properties keys
+ * @description Returns the keys of all properties for an organization. Use this resource when you need to find out what additional properties items have been added to an organization.
+ *
+ * **[Permissions](#permissions) required**: Any
+ *
+ * **Response limitations**: Customers can only access properties of organizations of which they are members.
+ */
+ get: operations["getPropertiesKeys"];
+ };
+ "/rest/servicedeskapi/organization/{organizationId}/property/{propertyKey}": {
+ /**
+ * Get property
+ * @description Returns the value of a property from an organization. Use this method to obtain the JSON content for an organization's property.
+ *
+ * **[Permissions](#permissions) required**: Any
+ *
+ * **Response limitations**: Customers can only access properties of organizations of which they are members.
+ */
+ get: operations["getProperty"];
+ /**
+ * Set property
+ * @description Sets the value of a property for an organization. Use this resource to store custom data against an organization.
+ *
+ * **[Permissions](#permissions) required**: Service Desk Administrator or Agent.
+ *
+ * Note: Permission to manage organizations can be switched to users with the Jira administrator permission, using the **[Organization management](https://confluence.atlassian.com/servicedeskcloud/setting-up-service-desk-users-732528877.html#Settingupservicedeskusers-manageorgsManageorganizations)** feature.
+ */
+ put: operations["setProperty"];
+ /**
+ * Delete property
+ * @description Removes a property from an organization.
+ *
+ * **[Permissions](#permissions) required**: Service Desk Administrator or Agent.
+ *
+ * Note: Permission to manage organizations can be switched to users with the Jira administrator permission, using the **[Organization management](https://confluence.atlassian.com/servicedeskcloud/setting-up-service-desk-users-732528877.html#Settingupservicedeskusers-manageorgsManageorganizations)** feature.
+ */
+ delete: operations["deleteProperty"];
+ };
+ "/rest/servicedeskapi/organization/{organizationId}/user": {
+ /**
+ * Get users in organization
+ * @description This method returns all the users associated with an organization. Use this method where you want to provide a list of users for an organization or determine if a user is associated with an organization.
+ *
+ * **[Permissions](#permissions) required**: Service desk administrator or agent.
+ */
+ get: operations["getUsersInOrganization"];
+ /**
+ * Add users to organization
+ * @description This method adds users to an organization.
+ *
+ * **[Permissions](#permissions) required**: Service desk administrator or agent. Note: Permission to add users to an organization can be switched to users with the Jira administrator permission, using the **[Organization management](https://confluence.atlassian.com/servicedeskcloud/setting-up-service-desk-users-732528877.html#Settingupservicedeskusers-manageorgsManageorganizations)** feature.
+ */
+ post: operations["addUsersToOrganization"];
+ /**
+ * Remove users from organization
+ * @description This method removes users from an organization.
+ *
+ * **[Permissions](#permissions) required**: Service desk administrator or agent. Note: Permission to delete users from an organization can be switched to users with the Jira administrator permission, using the **[Organization management](https://confluence.atlassian.com/servicedeskcloud/setting-up-service-desk-users-732528877.html#Settingupservicedeskusers-manageorgsManageorganizations)** feature.
+ */
+ delete: operations["removeUsersFromOrganization"];
+ };
+ "/rest/servicedeskapi/request": {
+ /**
+ * Get customer requests
+ * @description This method returns all customer requests for the user executing the query.
+ *
+ * The returned customer requests are ordered chronologically by the latest activity on each request. For example, the latest status transition or comment.
+ *
+ * **[Permissions](#permissions) required**: Permission to access the specified service desk.
+ *
+ * **Response limitations**: For customers, the list returned will include request they created (or were created on their behalf) or are participating in only.
+ */
+ get: operations["getCustomerRequests"];
+ /**
+ * Create customer request
+ * @description This method creates a customer request in a service desk.
+ *
+ * The JSON request must include the service desk and customer request type, as well as any fields that are required for the request type. A list of the fields required by a customer request type can be obtained using [servicedesk/\{serviceDeskId\}/requesttype/\{requestTypeId\}/field](#api-servicedesk-serviceDeskId-requesttype-requestTypeId-field-get).
+ *
+ * The fields required for a customer request type depend on the user's permissions:
+ *
+ * * `raiseOnBehalfOf` is not available to Users who have the customer permission only.
+ * * `requestParticipants` is not available to Users who have the customer permission only or if the feature is turned off for customers.
+ *
+ * `requestFieldValues` is a map of Jira field IDs and their values. See [Field input formats](#fieldformats), for details of each field's JSON semantics and the values they can take.
+ *
+ * **[Permissions](#permissions) required**: Permission to create requests in the specified service desk.
+ */
+ post: operations["createCustomerRequest"];
+ };
+ "/rest/servicedeskapi/request/{issueIdOrKey}": {
+ /**
+ * Get customer request by id or key
+ * @description This method returns a customer request.
+ *
+ * **[Permissions](#permissions) required**: Permission to access the specified service desk.
+ *
+ * **Response limitations**: For customers, only a request they created, was created on their behalf, or they are participating in will be returned.
+ *
+ * **Note:** `requestFieldValues` does not include hidden fields. To get a list of request type fields that includes hidden fields, see [/rest/servicedeskapi/servicedesk/\{serviceDeskId\}/requesttype/\{requestTypeId\}/field](https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk/#api-rest-servicedeskapi-servicedesk-servicedeskid-requesttype-requesttypeid-field-get)
+ */
+ get: operations["getCustomerRequestByIdOrKey"];
+ };
+ "/rest/servicedeskapi/request/{issueIdOrKey}/approval": {
+ /**
+ * Get approvals
+ * @description This method returns all approvals on a customer request.
+ *
+ * **[Permissions](#permissions) required**: Permission to view the customer request.
+ */
+ get: operations["getApprovals"];
+ };
+ "/rest/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId}": {
+ /**
+ * Get approval by id
+ * @description This method returns an approval. Use this method to determine the status of an approval and the list of approvers.
+ *
+ * **[Permissions](#permissions) required**: Permission to view the customer request.
+ */
+ get: operations["getApprovalById"];
+ /**
+ * Answer approval
+ * @description This method enables a user to **Approve** or **Decline** an approval on a customer request. The approval is assumed to be owned by the user making the call.
+ *
+ * **[Permissions](#permissions) required**: User is assigned to the approval request.
+ */
+ post: operations["answerApproval"];
+ };
+ "/rest/servicedeskapi/request/{issueIdOrKey}/attachment": {
+ /**
+ * Get attachments for request
+ * @description This method returns all the attachments for a customer requests.
+ *
+ * **[Permissions](#permissions) required**: Permission to view the customer request.
+ *
+ * **Response limitations**: Customers will only get a list of public attachments.
+ */
+ get: operations["getAttachmentsForRequest"];
+ /**
+ * Create comment with attachment
+ * @description This method creates a comment on a customer request using one or more attachment files (uploaded using [servicedeskapi/servicedesk/\{serviceDeskId\}/attachTemporaryFile](https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk/#api-rest-servicedeskapi-servicedesk-servicedeskid-attachtemporaryfile-post)), with the visibility set by `public`. See
+ *
+ * * GET [servicedeskapi/request/\{issueIdOrKey\}/attachment](./#api-rest-servicedeskapi-request-issueidorkey-attachment-get)
+ * * GET [servicedeskapi/request/\{issueIdOrKey\}/comment/\{commentId\}/attachment](./#api-rest-servicedeskapi-request-issueidorkey-comment-commentid-attachment-get)
+ *
+ * **[Permissions](#permissions) required**: Permission to add an attachment.
+ *
+ * **Request limitations**: Customers can set public visibility only.
+ */
+ post: operations["createCommentWithAttachment"];
+ };
+ "/rest/servicedeskapi/request/{issueIdOrKey}/attachment/{attachmentId}": {
+ /**
+ * Get attachment content
+ * @description Returns the contents of an attachment.
+ *
+ * To return a thumbnail of the attachment, use [servicedeskapi/request/\{issueIdOrKey\}/attachment/\{attachmentId\}/thumbnail](./#api-rest-servicedeskapi-request-issueidorkey-attachment-attachmentid-thumbnail-get).
+ *
+ * **[Permissions](#permissions) required:** For the issue containing the attachment:
+ *
+ * * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
+ * * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
+ */
+ get: operations["getAttachmentContent"];
+ };
+ "/rest/servicedeskapi/request/{issueIdOrKey}/attachment/{attachmentId}/thumbnail": {
+ /**
+ * Get attachment thumbnail
+ * @description Returns the thumbnail of an attachment.
+ *
+ * To return the attachment contents, use [servicedeskapi/request/\{issueIdOrKey\}/attachment/\{attachmentId\}](#api-rest-servicedeskapi-request-issueidorkey-attachment-attachmentid-get).
+ *
+ * **[Permissions](#permissions) required:** For the issue containing the attachment:
+ *
+ * * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
+ * * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
+ */
+ get: operations["getAttachmentThumbnail"];
+ };
+ "/rest/servicedeskapi/request/{issueIdOrKey}/comment": {
+ /**
+ * Get request comments
+ * @description This method returns all comments on a customer request. No permissions error is provided if, for example, the user doesn't have access to the service desk or request, the method simply returns an empty response.
+ *
+ * **[Permissions](#permissions) required**: Permission to view the customer request.
+ *
+ * **Response limitations**: Customers are returned public comments only.
+ */
+ get: operations["getRequestComments"];
+ /**
+ * Create request comment
+ * @description This method creates a public or private (internal) comment on a customer request, with the comment visibility set by `public`. The user recorded as the author of the comment.
+ *
+ * **[Permissions](#permissions) required**: User has Add Comments permission.
+ *
+ * **Request limitations**: Customers can set comments to public visibility only.
+ */
+ post: operations["createRequestComment"];
+ };
+ "/rest/servicedeskapi/request/{issueIdOrKey}/comment/{commentId}": {
+ /**
+ * Get request comment by id
+ * @description This method returns details of a customer request's comment.
+ *
+ * **[Permissions](#permissions) required**: Permission to view the customer request.
+ *
+ * **Response limitations**: Customers can only view public comments on requests where they are the reporter or a participant whereas agents can see both internal and public comments.
+ */
+ get: operations["getRequestCommentById"];
+ };
+ "/rest/servicedeskapi/request/{issueIdOrKey}/comment/{commentId}/attachment": {
+ /**
+ * Get comment attachments
+ * @description This method returns the attachments referenced in a comment.
+ *
+ * **[Permissions](#permissions) required**: Permission to view the customer request.
+ *
+ * **Response limitations**: Customers can only view public comments, and retrieve their attachments, on requests where they are the reporter or a participant whereas agents can see both internal and public comments.
+ */
+ get: operations["getCommentAttachments"];
+ };
+ "/rest/servicedeskapi/request/{issueIdOrKey}/notification": {
+ /**
+ * Get subscription status
+ * @description This method returns the notification subscription status of the user making the request. Use this method to determine if the user is subscribed to a customer request's notifications.
+ *
+ * **[Permissions](#permissions) required**: Permission to view the customer request.
+ */
+ get: operations["getSubscriptionStatus"];
+ /**
+ * Subscribe
+ * @description This method subscribes the user to receiving notifications from a customer request.
+ *
+ * **[Permissions](#permissions) required**: Permission to view the customer request.
+ */
+ put: operations["subscribe"];
+ /**
+ * Unsubscribe
+ * @description This method unsubscribes the user from notifications from a customer request.
+ *
+ * **[Permissions](#permissions) required**: Permission to view the customer request.
+ */
+ delete: operations["unsubscribe"];
+ };
+ "/rest/servicedeskapi/request/{issueIdOrKey}/participant": {
+ /**
+ * Get request participants
+ * @description This method returns a list of all the participants on a customer request.
+ *
+ * **[Permissions](#permissions) required**: Permission to view the customer request.
+ */
+ get: operations["getRequestParticipants"];
+ /**
+ * Add request participants
+ * @description This method adds participants to a customer request.
+ *
+ * **[Permissions](#permissions) required**: Permission to manage participants on the customer request.
+ *
+ * Note, participants can be added when creating a customer request using the [request](#api-request-post) resource, by defining the participants in the `requestParticipants` field.
+ */
+ post: operations["addRequestParticipants"];
+ /**
+ * Remove request participants
+ * @description This method removes participants from a customer request.
+ *
+ * **[Permissions](#permissions) required**: Permission to manage participants on the customer request.
+ */
+ delete: operations["removeRequestParticipants"];
+ };
+ "/rest/servicedeskapi/request/{issueIdOrKey}/sla": {
+ /**
+ * Get sla information
+ * @description This method returns all the SLA records on a customer request. A customer request can have zero or more SLAs. Each SLA can have recordings for zero or more "completed cycles" and zero or 1 "ongoing cycle". Each cycle includes information on when it started and stopped, and whether it breached the SLA goal.
+ *
+ * **[Permissions](#permissions) required**: Agent for the Service Desk containing the queried customer request.
+ */
+ get: operations["getSlaInformation"];
+ };
+ "/rest/servicedeskapi/request/{issueIdOrKey}/sla/{slaMetricId}": {
+ /**
+ * Get sla information by id
+ * @description This method returns the details for an SLA on a customer request.
+ *
+ * **[Permissions](#permissions) required**: Agent for the Service Desk containing the queried customer request.
+ */
+ get: operations["getSlaInformationById"];
+ };
+ "/rest/servicedeskapi/request/{issueIdOrKey}/status": {
+ /**
+ * Get customer request status
+ * @description This method returns a list of all the statuses a customer Request has achieved. A status represents the state of an issue in its workflow. An issue can have one active status only. The list returns the status history in chronological order, most recent (current) status first.
+ *
+ * **[Permissions](#permissions) required**: Permission to view the customer request.
+ */
+ get: operations["getCustomerRequestStatus"];
+ };
+ "/rest/servicedeskapi/request/{issueIdOrKey}/transition": {
+ /**
+ * Get customer transitions
+ * @description This method returns a list of transitions, the workflow processes that moves a customer request from one status to another, that the user can perform on a request. Use this method to provide a user with a list if the actions they can take on a customer request.
+ *
+ * **[Permissions](#permissions) required**: Permission to view the customer request.
+ */
+ get: operations["getCustomerTransitions"];
+ /**
+ * Perform customer transition
+ * @description This method performs a customer transition for a given request and transition. An optional comment can be included to provide a reason for the transition.
+ *
+ * **[Permissions](#permissions) required**: The user must be able to view the request and have the Transition Issues permission. If a comment is passed the user must have the Add Comments permission.
+ */
+ post: operations["performCustomerTransition"];
+ };
+ "/rest/servicedeskapi/request/{requestIdOrKey}/feedback": {
+ /**
+ * Get feedback
+ * @description This method retrieves a feedback of a request using it's `requestKey` or `requestId`
+ *
+ * **[Permissions](#permissions) required**: User has view request permissions.
+ */
+ get: operations["getFeedback"];
+ /**
+ * Post feedback
+ * @description This method adds a feedback on an request using it's `requestKey` or `requestId`
+ *
+ * **[Permissions](#permissions) required**: User must be the reporter or an Atlassian Connect app.
+ */
+ post: operations["postFeedback"];
+ /**
+ * Delete feedback
+ * @description This method deletes the feedback of request using it's `requestKey` or `requestId`
+ *
+ * **[Permissions](#permissions) required**: User must be the reporter or an Atlassian Connect app.
+ */
+ delete: operations["deleteFeedback"];
+ };
+ "/rest/servicedeskapi/requesttype": {
+ /**
+ * Get all request types
+ * @description This method returns all customer request types used in the Jira Service Management instance, optionally filtered by a query string.
+ *
+ * Use [servicedeskapi/servicedesk/\{serviceDeskId\}/requesttype](#api-servicedesk-serviceDeskId-requesttype-get) to find the customer request types supported by a specific service desk.
+ *
+ * The returned list of customer request types can be filtered using the `query` parameter. The parameter is matched against the customer request types' `name` or `description`. For example, searching for "Install", "Inst", "Equi", or "Equipment" will match a customer request type with the *name* "Equipment Installation Request".
+ *
+ * **Note:** This API will filter out hidden request types (aka.request types without groups) when `query` is provided.
+ *
+ * **[Permissions](#permissions) required**: Any
+ */
+ get: operations["getAllRequestTypes"];
+ };
+ "/rest/servicedeskapi/servicedesk": {
+ /**
+ * Get service desks
+ * @description This method returns all the service desks in the Jira Service Management instance that the user has permission to access. Use this method where you need a list of service desks or need to locate a service desk by name or keyword.
+ *
+ * **Note:** This method will be slow if the instance has hundreds of service desks. If you want to fetch a single service desk by its ID, use [/rest/servicedeskapi/servicedesk/\{serviceDeskId\}](./#api-rest-servicedeskapi-servicedesk-servicedeskid-get) instead.
+ *
+ * **[Permissions](#permissions) required**: Any
+ */
+ get: operations["getServiceDesks"];
+ };
+ "/rest/servicedeskapi/servicedesk/{serviceDeskId}": {
+ /**
+ * Get service desk by id
+ * @description This method returns a service desk. Use this method to get service desk details whenever your application component is passed a service desk ID but needs to display other service desk details.
+ *
+ * **[Permissions](#permissions) required**: Permission to access the Service Desk. For example, being the Service Desk's Administrator or one of its Agents or Users.
+ */
+ get: operations["getServiceDeskById"];
+ };
+ "/rest/servicedeskapi/servicedesk/{serviceDeskId}/attachTemporaryFile": {
+ /**
+ * Attach temporary file
+ * @description This method adds one or more temporary attachments to a service desk, which can then be permanently attached to a customer request using [servicedeskapi/request/\{issueIdOrKey\}/attachment](#api-request-issueIdOrKey-attachment-post).
+ *
+ * **Note**: It is possible for a service desk administrator to turn off the ability to add attachments to a service desk.
+ *
+ * This method expects a multipart request. The media-type multipart/form-data is defined in RFC 1867. Most client libraries have classes that make dealing with multipart posts simple. For instance, in Java the Apache HTTP Components library provides [MultiPartEntity](http://hc.apache.org/httpcomponents-client-ga/httpmime/apidocs/org/apache/http/entity/mime/MultipartEntity.html).
+ *
+ * Because this method accepts multipart/form-data, it has XSRF protection on it. This means you must submit a header of X-Atlassian-Token: no-check with the request or it will be blocked.
+ *
+ * The name of the multipart/form-data parameter that contains the attachments must be `file`.
+ *
+ * For example, to upload a file called `myfile.txt` in the Service Desk with ID 10001 use
+ *
+ * curl -D- -u customer:customer -X POST -H "X-ExperimentalApi: opt-in" -H "X-Atlassian-Token: no-check" -F "file=@myfile.txt" https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/10001/attachTemporaryFile
+ *
+ * **[Permissions](#permissions) required**: Permission to add attachments in this Service Desk.
+ */
+ post: operations["attachTemporaryFile"];
+ };
+ "/rest/servicedeskapi/servicedesk/{serviceDeskId}/customer": {
+ /**
+ * Get customers
+ * @description This method returns a list of the customers on a service desk.
+ *
+ * The returned list of customers can be filtered using the `query` parameter. The parameter is matched against customers' `displayName`, `name`, or `email`. For example, searching for "John", "Jo", "Smi", or "Smith" will match a user with display name "John Smith".
+ *
+ * **[Permissions](#permissions) required**: Permission to view this Service Desk's customers.
+ */
+ get: operations["getCustomers"];
+ /**
+ * Add customers
+ * @description Adds one or more customers to a service desk. If any of the passed customers are associated with the service desk, no changes will be made for those customers and the resource returns a 204 success code.
+ *
+ * **[Permissions](#permissions) required**: Service desk administrator
+ */
+ post: operations["addCustomers"];
+ /**
+ * Remove customers
+ * @description This method removes one or more customers from a service desk. The service desk must have closed access. If any of the passed customers are not associated with the service desk, no changes will be made for those customers and the resource returns a 204 success code.
+ *
+ * **[Permissions](#permissions) required**: Services desk administrator
+ */
+ delete: operations["removeCustomers"];
+ };
+ "/rest/servicedeskapi/servicedesk/{serviceDeskId}/knowledgebase/article": {
+ /**
+ * Get articles
+ * @description Returns articles which match the given query and belong to the knowledge base linked to the service desk.
+ *
+ * **[Permissions](#permissions) required**: Permission to access the service desk.
+ */
+ get: operations["getArticles"];
+ };
+ "/rest/servicedeskapi/servicedesk/{serviceDeskId}/organization": {
+ /**
+ * Get organizations
+ * @description This method returns a list of all organizations associated with a service desk.
+ *
+ * **[Permissions](#permissions) required**: Service desk's agent.
+ */
+ get: operations["getOrganizations"];
+ /**
+ * Add organization
+ * @description This method adds an organization to a service desk. If the organization ID is already associated with the service desk, no change is made and the resource returns a 204 success code.
+ *
+ * **[Permissions](#permissions) required**: Service desk's agent.
+ */
+ post: operations["addOrganization"];
+ /**
+ * Remove organization
+ * @description This method removes an organization from a service desk. If the organization ID does not match an organization associated with the service desk, no change is made and the resource returns a 204 success code.
+ *
+ * **[Permissions](#permissions) required**: Service desk's agent.
+ */
+ delete: operations["removeOrganization"];
+ };
+ "/rest/servicedeskapi/servicedesk/{serviceDeskId}/queue": {
+ /**
+ * Get queues
+ * @description This method returns the queues in a service desk. To include a customer request count for each queue (in the `issueCount` field) in the response, set the query parameter `includeCount` to true (its default is false).
+ *
+ * **[Permissions](#permissions) required**: service desk's Agent.
+ */
+ get: operations["getQueues"];
+ };
+ "/rest/servicedeskapi/servicedesk/{serviceDeskId}/queue/{queueId}": {
+ /**
+ * Get queue
+ * @description This method returns a specific queues in a service desk. To include a customer request count for the queue (in the `issueCount` field) in the response, set the query parameter `includeCount` to true (its default is false).
+ *
+ * **[Permissions](#permissions) required**: service desk's Agent.
+ */
+ get: operations["getQueue"];
+ };
+ "/rest/servicedeskapi/servicedesk/{serviceDeskId}/queue/{queueId}/issue": {
+ /**
+ * Get issues in queue
+ * @description This method returns the customer requests in a queue. Only fields that the queue is configured to show are returned. For example, if a queue is configured to show description and due date, then only those two fields are returned for each customer request in the queue.
+ *
+ * **[Permissions](#permissions) required**: Service desk's agent.
+ */
+ get: operations["getIssuesInQueue"];
+ };
+ "/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype": {
+ /**
+ * Get request types
+ * @description This method returns all customer request types from a service desk. There are two parameters for filtering the returned list:
+ *
+ * * `groupId` which filters the results to items in the customer request type group.
+ * * `searchQuery` which is matched against request types' `name` or `description`. For example, the strings "Install", "Inst", "Equi", or "Equipment" will match a request type with the *name* "Equipment Installation Request".
+ *
+ * **Note:** This API by default will filter out hidden request types (aka.request types without groups) when `searchQuery` is provided, unless `includeHiddenRequestTypesInSearch` is set to true.
+ *
+ * **[Permissions](#permissions) required**: Permission to access the service desk.
+ */
+ get: operations["getRequestTypes"];
+ /**
+ * Create request type
+ * @description This method enables a customer request type to be added to a service desk based on an issue type. Note that not all customer request type fields can be specified in the request and these fields are given the following default values:
+ *
+ * * Request type icon is given the headset icon.
+ * * Request type groups is left empty, which means this customer request type will not be visible on the [customer portal](https://confluence.atlassian.com/servicedeskcloud/configuring-the-customer-portal-732528918.html).
+ * * Request type status mapping is left empty, so the request type has no custom status mapping but inherits the status map from the issue type upon which it is based.
+ * * Request type field mapping is set to show the required fields as specified by the issue type used to create the customer request type.
+ *
+ *
+ * These fields can be updated by a service desk administrator using the **Request types** option in **Project settings**.
+ * Request Types are created in next-gen projects by creating Issue Types. Please use the Jira Cloud Platform Create issue type endpoint instead.
+ *
+ * **[Permissions](#permissions) required**: Service desk's administrator
+ */
+ post: operations["createRequestType"];
+ };
+ "/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}": {
+ /**
+ * Get request type by id
+ * @description This method returns a customer request type from a service desk.
+ *
+ * This operation can be accessed anonymously.
+ *
+ * **[Permissions](#permissions) required**: Permission to access the service desk.
+ */
+ get: operations["getRequestTypeById"];
+ /**
+ * Delete request type
+ * @description This method deletes a customer request type from a service desk, and removes it from all customer requests.
+ * This only supports classic projects.
+ *
+ * **[Permissions](#permissions) required**: Service desk administrator.
+ */
+ delete: operations["deleteRequestType"];
+ };
+ "/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/field": {
+ /**
+ * Get request type fields
+ * @description This method returns the fields for a service desk's customer request type.
+ *
+ * Also, the following information about the user's permissions for the request type is returned:
+ *
+ * * `canRaiseOnBehalfOf` returns `true` if the user has permission to raise customer requests on behalf of other customers. Otherwise, returns `false`.
+ * * `canAddRequestParticipants` returns `true` if the user can add customer request participants. Otherwise, returns `false`.
+ *
+ * **[Permissions](#permissions) required**: Permission to view the Service Desk. However, hidden fields would be visible to only Service desk's Administrator.
+ */
+ get: operations["getRequestTypeFields"];
+ };
+ "/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/property": {
+ /**
+ * Get properties keys
+ * @description Returns the keys of all properties for a request type.
+ *
+ * Properties for a Request Type in next-gen are stored as Issue Type properties and therefore the keys of all properties for a request type are also available by calling the Jira Cloud Platform [Get issue type property keys](https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issuetype-issueTypeId-properties-get) endpoint.
+ *
+ * **[Permissions](#permissions) required**: The user must have permission to view the request type.
+ */
+ get: operations["getPropertiesKeys"];
+ };
+ "/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/property/{propertyKey}": {
+ /**
+ * Get property
+ * @description Returns the value of the property from a request type.
+ *
+ * Properties for a Request Type in next-gen are stored as Issue Type properties and therefore also available by calling the Jira Cloud Platform [Get issue type property](https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issuetype-issueTypeId-properties-propertyKey-get) endpoint.
+ *
+ * **[Permissions](#permissions) required**: User must have permission to view the request type.
+ */
+ get: operations["getProperty"];
+ /**
+ * Set property
+ * @description Sets the value of a request type property. Use this resource to store custom data against a request type.
+ *
+ * Properties for a Request Type in next-gen are stored as Issue Type properties and therefore can also be set by calling the Jira Cloud Platform [Set issue type property](https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issuetype-issueTypeId-properties-propertyKey-put) endpoint.
+ *
+ * **[Permissions](#permissions) required**: Jira project administrator with a Jira Service Management agent license.
+ */
+ put: operations["setProperty"];
+ /**
+ * Delete property
+ * @description Removes a property from a request type.
+ *
+ * Properties for a Request Type in next-gen are stored as Issue Type properties and therefore can also be deleted by calling the Jira Cloud Platform [Delete issue type property](https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issuetype-issueTypeId-properties-propertyKey-delete) endpoint.
+ *
+ * **[Permissions](#permissions) required**: Jira project administrator with a Jira Service Management agent license.
+ */
+ delete: operations["deleteProperty"];
+ };
+ "/rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttypegroup": {
+ /**
+ * Get request type groups
+ * @description This method returns a service desk's customer request type groups. Jira Service Management administrators can arrange the customer request type groups in an arbitrary order for display on the customer portal; the groups are returned in this order.
+ *
+ * **[Permissions](#permissions) required**: Permission to view the service desk.
+ */
+ get: operations["getRequestTypeGroups"];
+ };
+}
+
+export type webhooks = Record;
+
+export interface components {
+ schemas: {
+ AdditionalCommentDTO: {
+ /** @description Content of the comment. */
+ body?: string;
+ };
+ ApprovalDTO: {
+ /** @description The REST API URL of the approval. */
+ _links?: components["schemas"]["SelfLinkDTO"];
+ /** @description Detailed list of the users who must provide a response to the approval. */
+ approvers?: components["schemas"]["ApproverDTO"][];
+ /** @description Indicates whether the user making the request is one of the approvers and can respond to the approval (true) or not (false). */
+ canAnswerApproval?: boolean;
+ /** @description Date the approval was completed. */
+ completedDate?: components["schemas"]["DateDTO"];
+ /** @description Date the approval was created. */
+ createdDate?: components["schemas"]["DateDTO"];
+ /**
+ * @description Outcome of the approval, based on the approvals provided by all approvers.
+ * @enum {string}
+ */
+ finalDecision?: "approved" | "declined" | "pending";
+ /** @description ID of the approval. */
+ id?: string;
+ /** @description Description of the approval being sought or provided. */
+ name?: string;
+ };
+ ApprovalDecisionRequestDTO: {
+ /**
+ * @description Response to the approval request.
+ * @enum {string}
+ */
+ decision?: "approve" | "decline";
+ };
+ ApproverDTO: {
+ /** @description Details of the User who is providing approval. */
+ approver?: components["schemas"]["UserDTO"];
+ /**
+ * @description Decision made by the approver.
+ * @enum {string}
+ */
+ approverDecision?: "approved" | "declined" | "pending";
+ };
+ ArticleDTO: {
+ content?: components["schemas"]["ContentDTO"];
+ /** @description Excerpt of the article which matches the given query string. */
+ excerpt?: string;
+ /** @description Source of the article. */
+ source?: components["schemas"]["SourceDTO"];
+ /** @description Title of the article. */
+ title?: string;
+ };
+ /** @description Details of an Assets workspace ID. */
+ AssetsWorkspaceDTO: {
+ /** @description The workspace ID used as the identifier to access the Assets REST API. */
+ workspaceId?: string;
+ };
+ AttachmentCreateDTO: {
+ /** @description Additional content of the comment */
+ additionalComment?: components["schemas"]["AdditionalCommentDTO"];
+ /** @description Controls whether the comment and its attachments are visible to customers */
+ public?: boolean;
+ /** @description List of IDs for the temporary attachments to be added to the customer request. */
+ temporaryAttachmentIds?: string[];
+ };
+ AttachmentCreateResultDTO: {
+ /** @description List of the attachments added. */
+ attachments?: components["schemas"]["PagedDTOAttachmentDTO"];
+ /** @description Details of the comment included with the attachments. */
+ comment?: components["schemas"]["CommentDTO"];
+ };
+ AttachmentDTO: {
+ /** @description Various URLs for the attachment. */
+ _links?: components["schemas"]["AttachmentLinkDTO"];
+ /** @description Details of the user who attached the file. */
+ author?: components["schemas"]["UserDTO"];
+ /** @description Date the attachment was added. */
+ created?: components["schemas"]["DateDTO"];
+ /** @description Filename of the item attached. */
+ filename?: string;
+ /** @description MIME type of the attachment. */
+ mimeType?: string;
+ /**
+ * Format: int64
+ * @description Size of the attachment in bytes.
+ */
+ size?: number;
+ };
+ AttachmentLinkDTO: {
+ /**
+ * Format: uri
+ * @description URL for the attachment.
+ */
+ content?: string;
+ /**
+ * Format: uri
+ * @description REST API URL for the attachment
+ */
+ jiraRest?: string;
+ /** Format: uri */
+ self?: string;
+ /**
+ * Format: uri
+ * @description URL for the attachment's thumbnail image.
+ */
+ thumbnail?: string;
+ };
+ AvatarUrlsBean: {
+ /**
+ * Format: uri
+ * @description The URL of the item's 16x16 pixel avatar.
+ */
+ "16x16"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the item's 24x24 pixel avatar.
+ */
+ "24x24"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the item's 32x32 pixel avatar.
+ */
+ "32x32"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the item's 48x48 pixel avatar.
+ */
+ "48x48"?: string;
+ };
+ CSATFeedbackFullDTO: {
+ /** @description (Optional) The comment provided with this feedback. */
+ comment?: components["schemas"]["AdditionalCommentDTO"];
+ /**
+ * Format: int32
+ * @description A numeric representation of the rating, this must be an integer value between 1 and 5.
+ */
+ rating?: number;
+ /** @description Indicates the type of feedback, supported values: `csat`. */
+ type?: string;
+ };
+ /** @description A change item. */
+ ChangeDetails: {
+ /** @description The name of the field changed. */
+ field?: string;
+ /** @description The ID of the field changed. */
+ fieldId?: string;
+ /** @description The type of the field changed. */
+ fieldtype?: string;
+ /** @description The details of the original value. */
+ from?: string;
+ /** @description The details of the original value as a string. */
+ fromString?: string;
+ /** @description The details of the new value. */
+ to?: string;
+ /** @description The details of the new value as a string. */
+ toString?: string;
+ };
+ /** @description A log of changes made to issue fields. Changelogs related to workflow associations are currently being deprecated. */
+ Changelog: {
+ /** @description The user who made the change. */
+ author?: components["schemas"]["UserDetails"];
+ /**
+ * Format: date-time
+ * @description The date on which the change took place.
+ */
+ created?: string;
+ /** @description The history metadata associated with the changed. */
+ historyMetadata?: components["schemas"]["HistoryMetadata"];
+ /** @description The ID of the changelog. */
+ id?: string;
+ /** @description The list of items changed. */
+ items?: readonly components["schemas"]["ChangeDetails"][];
+ };
+ CommentCreateDTO: {
+ /** @description Content of the comment. */
+ body?: string;
+ /** @description Indicates whether the comment is public (true) or private/internal (false). */
+ public?: boolean;
+ };
+ CommentDTO: {
+ /** @description List of items that can be expanded in the response by specifying the expand query parameter. */
+ _expands?: string[];
+ /** @description REST API URL link to the comment. */
+ _links?: components["schemas"]["SelfLinkDTO"];
+ /** @description List of the attachments included in the comment. */
+ attachments?: components["schemas"]["PagedDTOAttachmentDTO"];
+ /** @description Details of the customer who authored the comment. */
+ author?: components["schemas"]["UserDTO"];
+ /** @description Content of the comment. */
+ body?: string;
+ /** @description Date the comment was created. */
+ created?: components["schemas"]["DateDTO"];
+ /** @description ID of the comment. */
+ id?: string;
+ /** @description Indicates whether the comment is public (true) or private/internal (false). */
+ public?: boolean;
+ /** @description The rendered body of the comment. */
+ renderedBody?: components["schemas"]["RenderedValueDTO"];
+ };
+ ContentDTO: {
+ /** @description Url containing the body of the article (without title), suitable for rendering in an iframe */
+ iframeSrc?: string;
+ };
+ CustomerCreateDTO: {
+ /** @description Customer's name for display in the UI. */
+ displayName?: string;
+ /** @description Customer's email address. */
+ email?: string;
+ /** @description Deprecated, please use 'displayName'. */
+ fullName?: string;
+ };
+ CustomerRequestActionDTO: {
+ /** @description Indicates whether the user can undertake the action (true) or not (false). */
+ allowed?: boolean;
+ };
+ CustomerRequestActionsDTO: {
+ /** @description Action of adding attachments to a request. */
+ addAttachment?: components["schemas"]["CustomerRequestActionDTO"];
+ /** @description Action of adding comments to a request. */
+ addComment?: components["schemas"]["CustomerRequestActionDTO"];
+ /** @description Action of adding participants to a request. */
+ addParticipant?: components["schemas"]["CustomerRequestActionDTO"];
+ /** @description Action of removing participants from a request. */
+ removeParticipant?: components["schemas"]["CustomerRequestActionDTO"];
+ };
+ CustomerRequestCreateMetaDTO: {
+ /** @description Flag indicating if participants can be added to a request (true) or not. */
+ canAddRequestParticipants?: boolean;
+ /** @description Flag indicating if a request can be raised on behalf of another user (true) or not. */
+ canRaiseOnBehalfOf?: boolean;
+ /** @description List of the fields included in this request. */
+ requestTypeFields?: components["schemas"]["RequestTypeFieldDTO"][];
+ };
+ CustomerRequestDTO: {
+ /** @description List of items that can be expanded in the response by specifying the expand query parameter. */
+ _expands?: string[];
+ /** @description List of links associated with the request. */
+ _links?: components["schemas"]["CustomerRequestLinkDTO"];
+ /** @description List of actions that the user can take on the request. */
+ actions?: components["schemas"]["CustomerRequestActionsDTO"];
+ /** @description List of attachments included with the request. */
+ attachments?: components["schemas"]["PagedDTOAttachmentDTO"];
+ /** @description List of comments included with the request. */
+ comments?: components["schemas"]["PagedDTOCommentDTO"];
+ /** @description Date on which the request was created. */
+ createdDate?: components["schemas"]["DateDTO"];
+ /** @description Status of the request. */
+ currentStatus?: components["schemas"]["CustomerRequestStatusDTO"];
+ /** @description ID of the request, as the peer issue ID. */
+ issueId?: string;
+ /** @description Key of the request, as the peer issue key. */
+ issueKey?: string;
+ /** @description Expandable details of the customers participating in the request. */
+ participants?: components["schemas"]["PagedDTOUserDTO"];
+ /** @description Details of the customer reporting the request. */
+ reporter?: components["schemas"]["UserDTO"];
+ /** @description JSON map of Jira field IDs and their values representing the content of the request. This list does not include hidden fields. */
+ requestFieldValues?: components["schemas"]["CustomerRequestFieldValueDTO"][];
+ /** @description Expandable details of the request type. */
+ requestType?: components["schemas"]["RequestTypeDTO"];
+ /** @description ID of the request type for the request. */
+ requestTypeId?: string;
+ /** @description Expandable details of the service desk. */
+ serviceDesk?: components["schemas"]["ServiceDeskDTO"];
+ /** @description ID of the service desk the request belongs to. */
+ serviceDeskId?: string;
+ /** @description Expandable details of the SLAs relating to the request. */
+ sla?: components["schemas"]["PagedDTOSlaInformationDTO"];
+ /** @description Expandable details of the request's status history. */
+ status?: components["schemas"]["PagedDTOCustomerRequestStatusDTO"];
+ };
+ CustomerRequestFieldValueDTO: {
+ /** @description ID of the field. */
+ fieldId?: string;
+ /** @description Text label for the field. */
+ label?: string;
+ /** @description Value of the field rendered in the UI. */
+ renderedValue?: Record;
+ /** @description Value of the field. */
+ value?: unknown;
+ };
+ CustomerRequestLinkDTO: {
+ /**
+ * Format: uri
+ * @description Jira agent view URL for the request.
+ */
+ agent?: string;
+ /**
+ * Format: uri
+ * @description REST API URL for the request.
+ */
+ jiraRest?: string;
+ /** Format: uri */
+ self?: string;
+ /**
+ * Format: uri
+ * @description Web URL for the request.
+ */
+ web?: string;
+ };
+ CustomerRequestStatusDTO: {
+ /** @description Name of the status condition. */
+ status?: string;
+ /**
+ * @description Status category the status belongs to.
+ * @enum {string}
+ */
+ statusCategory?: "UNDEFINED" | "NEW" | "INDETERMINATE" | "DONE";
+ /** @description Date on which the status was attained. */
+ statusDate?: components["schemas"]["DateDTO"];
+ };
+ CustomerTransitionDTO: {
+ /** @description ID of the transition. */
+ id?: string;
+ /** @description Name of the transition. */
+ name?: string;
+ };
+ CustomerTransitionExecutionDTO: {
+ /** @description Comment explaining the reason for the transition. */
+ additionalComment?: components["schemas"]["AdditionalCommentDTO"];
+ /** @description ID of the transition to be performed. */
+ id?: string;
+ };
+ DateDTO: {
+ /**
+ * Format: int64
+ * @description Date as the number of milliseconds that have elapsed since 00:00:00 Coordinated Universal Time (UTC), 1 January 1970.
+ */
+ epochMillis?: number;
+ /** @description Date in a user-friendly text format. */
+ friendly?: string;
+ /** @description Date in ISO8601 format. */
+ iso8601?: string;
+ /** @description Date in the format used in the Jira REST APIs, which is ISO8601 format but extended with milliseconds. For example, 2016-09-28T23:08:32.097+1000. */
+ jira?: string;
+ };
+ DurationDTO: {
+ /** @description Duration in a user-friendly text format. */
+ friendly?: string;
+ /**
+ * Format: int64
+ * @description Duration in milliseconds.
+ */
+ millis?: number;
+ };
+ /** @description An entity property, for more information see [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/). */
+ EntityProperty: {
+ /** @description The key of the property. Required on create and update. */
+ key?: string;
+ /** @description The value of the property. Required on create and update. */
+ value?: unknown;
+ };
+ ErrorResponse: {
+ errorMessage?: string;
+ i18nErrorMessage?: components["schemas"]["I18nErrorMessage"];
+ };
+ Expandable: {
+ _expands?: string[];
+ };
+ /** @description The metadata describing an issue field. */
+ FieldMetadata: {
+ /** @description The list of values allowed in the field. */
+ allowedValues?: readonly unknown[];
+ /** @description The URL that can be used to automatically complete the field. */
+ autoCompleteUrl?: string;
+ /** @description The configuration properties. */
+ configuration?: {
+ [key: string]: unknown;
+ };
+ /** @description The default value of the field. */
+ defaultValue?: unknown;
+ /** @description Whether the field has a default value. */
+ hasDefaultValue?: boolean;
+ /** @description The key of the field. */
+ key: string;
+ /** @description The name of the field. */
+ name: string;
+ /** @description The list of operations that can be performed on the field. */
+ operations: readonly string[];
+ /** @description Whether the field is required. */
+ required: boolean;
+ /** @description The data type of the field. */
+ schema: components["schemas"]["JsonTypeBean"];
+ };
+ Form: {
+ /** @description JSON mapping of form field answers containing form field IDs and corresponding values. */
+ answers?: {
+ [key: string]: components["schemas"]["FormAnswer"];
+ };
+ [key: string]: unknown;
+ };
+ FormAnswer: {
+ /** @description Answer in Atlassian Document Format (ADF) */
+ adf?: components["schemas"]["JsonNode"];
+ /** @description IDs of selected choices */
+ choices?: string[];
+ /** @description Answer in date format (yyyy-MM-dd) */
+ date?: string;
+ /** @description The IDs of files to be attached to the form that are obtained by calling the ‘attach temporary file’ endpoint on the corresponding service desk. */
+ files?: string[];
+ /** @description Answer in free text format */
+ text?: string;
+ /** @description Answer in timestamp format (HH:mm) */
+ time?: string;
+ /** @description IDs of selected users */
+ users?: string[];
+ };
+ /** @description Details of issue history metadata. */
+ HistoryMetadata: {
+ /** @description The activity described in the history record. */
+ activityDescription?: string;
+ /** @description The key of the activity described in the history record. */
+ activityDescriptionKey?: string;
+ /** @description Details of the user whose action created the history record. */
+ actor?: components["schemas"]["HistoryMetadataParticipant"];
+ /** @description Details of the cause that triggered the creation the history record. */
+ cause?: components["schemas"]["HistoryMetadataParticipant"];
+ /** @description The description of the history record. */
+ description?: string;
+ /** @description The description key of the history record. */
+ descriptionKey?: string;
+ /** @description The description of the email address associated the history record. */
+ emailDescription?: string;
+ /** @description The description key of the email address associated the history record. */
+ emailDescriptionKey?: string;
+ /** @description Additional arbitrary information about the history record. */
+ extraData?: {
+ [key: string]: string;
+ };
+ /** @description Details of the system that generated the history record. */
+ generator?: components["schemas"]["HistoryMetadataParticipant"];
+ /** @description The type of the history record. */
+ type?: string;
+ [key: string]: unknown;
+ };
+ /** @description Details of user or system associated with a issue history metadata item. */
+ HistoryMetadataParticipant: {
+ /** @description The URL to an avatar for the user or system associated with a history record. */
+ avatarUrl?: string;
+ /** @description The display name of the user or system associated with a history record. */
+ displayName?: string;
+ /** @description The key of the display name of the user or system associated with a history record. */
+ displayNameKey?: string;
+ /** @description The ID of the user or system associated with a history record. */
+ id?: string;
+ /** @description The type of the user or system associated with a history record. */
+ type?: string;
+ /** @description The URL of the user or system associated with a history record. */
+ url?: string;
+ [key: string]: unknown;
+ };
+ I18nErrorMessage: {
+ i18nKey?: string;
+ parameters?: string[];
+ };
+ IncludedFields: {
+ actuallyIncluded?: string[];
+ excluded?: string[];
+ included?: string[];
+ };
+ InputStreamSource: {
+ inputStream?: Record;
+ };
+ /** @description Details of an insight workspace ID. */
+ InsightWorkspaceDTO: {
+ /** @description The workspace ID used as the identifier to access the Insight REST API. */
+ workspaceId?: string;
+ };
+ /** @description Details about an issue. */
+ IssueBean: {
+ /** @description Details of changelogs associated with the issue. */
+ changelog?: components["schemas"]["PageOfChangelogs"];
+ /** @description The metadata for the fields on the issue that can be amended. */
+ editmeta?: components["schemas"]["IssueUpdateMetadata"];
+ /** @description Expand options that include additional issue details in the response. */
+ expand?: string;
+ fields?: {
+ [key: string]: unknown;
+ };
+ fieldsToInclude?: components["schemas"]["IncludedFields"];
+ /** @description The ID of the issue. */
+ id?: string;
+ /** @description The key of the issue. */
+ key?: string;
+ /** @description The ID and name of each field present on the issue. */
+ names?: {
+ [key: string]: string;
+ };
+ /** @description The operations that can be performed on the issue. */
+ operations?: components["schemas"]["Operations"];
+ /** @description Details of the issue properties identified in the request. */
+ properties?: {
+ [key: string]: unknown;
+ };
+ /** @description The rendered value of each field present on the issue. */
+ renderedFields?: {
+ [key: string]: unknown;
+ };
+ /** @description The schema describing each field present on the issue. */
+ schema?: {
+ [key: string]: components["schemas"]["JsonTypeBean"];
+ };
+ /**
+ * Format: uri
+ * @description The URL of the issue details.
+ */
+ self?: string;
+ /** @description The transitions that can be performed on the issue. */
+ transitions?: readonly components["schemas"]["IssueTransition"][];
+ /** @description The versions of each field on the issue. */
+ versionedRepresentations?: {
+ [key: string]: {
+ [key: string]: unknown;
+ };
+ };
+ };
+ /** @description Details of an issue transition. */
+ IssueTransition: {
+ /** @description Expand options that include additional transition details in the response. */
+ expand?: string;
+ /** @description Details of the fields associated with the issue transition screen. Use this information to populate `fields` and `update` in a transition request. */
+ fields?: {
+ [key: string]: components["schemas"]["FieldMetadata"];
+ };
+ /** @description Whether there is a screen associated with the issue transition. */
+ hasScreen?: boolean;
+ /** @description The ID of the issue transition. Required when specifying a transition to undertake. */
+ id?: string;
+ /** @description Whether the transition is available to be performed. */
+ isAvailable?: boolean;
+ /** @description Whether the issue has to meet criteria before the issue transition is applied. */
+ isConditional?: boolean;
+ /** @description Whether the issue transition is global, that is, the transition is applied to issues regardless of their status. */
+ isGlobal?: boolean;
+ /** @description Whether this is the initial issue transition for the workflow. */
+ isInitial?: boolean;
+ looped?: boolean;
+ /** @description The name of the issue transition. */
+ name?: string;
+ /** @description Details of the issue status after the transition. */
+ to?: components["schemas"]["StatusDetails"];
+ [key: string]: unknown;
+ };
+ /** @description A list of editable field details. */
+ IssueUpdateMetadata: {
+ fields?: {
+ [key: string]: components["schemas"]["FieldMetadata"];
+ };
+ };
+ JsonNode: {
+ array?: boolean;
+ bigDecimal?: boolean;
+ bigInteger?: boolean;
+ bigIntegerValue?: number;
+ binary?: boolean;
+ binaryValue?: string[];
+ boolean?: boolean;
+ booleanValue?: boolean;
+ containerNode?: boolean;
+ decimalValue?: number;
+ double?: boolean;
+ /** Format: double */
+ doubleValue?: number;
+ elements?: Record;
+ fieldNames?: Record;
+ fields?: Record;
+ floatingPointNumber?: boolean;
+ int?: boolean;
+ /** Format: int32 */
+ intValue?: number;
+ integralNumber?: boolean;
+ long?: boolean;
+ /** Format: int64 */
+ longValue?: number;
+ missingNode?: boolean;
+ null?: boolean;
+ number?: boolean;
+ /** @enum {string} */
+ numberType?: "INT" | "LONG" | "BIG_INTEGER" | "FLOAT" | "DOUBLE" | "BIG_DECIMAL";
+ numberValue?: number;
+ object?: boolean;
+ pojo?: boolean;
+ textValue?: string;
+ textual?: boolean;
+ valueAsBoolean?: boolean;
+ /** Format: double */
+ valueAsDouble?: number;
+ /** Format: int32 */
+ valueAsInt?: number;
+ /** Format: int64 */
+ valueAsLong?: number;
+ valueAsText?: string;
+ valueNode?: boolean;
+ };
+ /** @description The schema of a field. */
+ JsonTypeBean: {
+ /** @description If the field is a custom field, the configuration of the field. */
+ configuration?: {
+ [key: string]: unknown;
+ };
+ /** @description If the field is a custom field, the URI of the field. */
+ custom?: string;
+ /**
+ * Format: int64
+ * @description If the field is a custom field, the custom ID of the field.
+ */
+ customId?: number;
+ /** @description When the data type is an array, the name of the field items within the array. */
+ items?: string;
+ /** @description If the field is a system field, the name of the field. */
+ system?: string;
+ /** @description The data type of the field. */
+ type: string;
+ };
+ /** @description Details a link group, which defines issue operations. */
+ LinkGroup: {
+ groups?: components["schemas"]["LinkGroup"][];
+ header?: components["schemas"]["SimpleLink"];
+ id?: string;
+ links?: components["schemas"]["SimpleLink"][];
+ styleClass?: string;
+ /** Format: int32 */
+ weight?: number;
+ };
+ Linkable: {
+ _links?: components["schemas"]["SelfLinkDTO"];
+ };
+ LinkableAttachmentLinkDTO: {
+ _links?: components["schemas"]["AttachmentLinkDTO"];
+ };
+ LinkableCustomerRequestLinkDTO: {
+ _links?: components["schemas"]["CustomerRequestLinkDTO"];
+ };
+ LinkableUserLinkDTO: {
+ _links?: components["schemas"]["UserLinkDTO"];
+ };
+ MultipartFile: {
+ bytes?: string[];
+ contentType?: string;
+ empty?: boolean;
+ inputStream?: Record;
+ name?: string;
+ originalFilename?: string;
+ resource?: components["schemas"]["Resource"];
+ /** Format: int64 */
+ size?: number;
+ };
+ /** @description Details of the operations that can be performed on the issue. */
+ Operations: {
+ /** @description Details of the link groups defining issue operations. */
+ linkGroups?: readonly components["schemas"]["LinkGroup"][];
+ [key: string]: unknown;
+ };
+ OrganizationCreateDTO: {
+ /** @description Name of the organization. Must contain 1-200 characters. */
+ name: string;
+ };
+ OrganizationDTO: {
+ /** @description REST API URL to the organization. */
+ _links?: components["schemas"]["SelfLinkDTO"];
+ /** @description Date the organization was created. This field may not be present in some older organizations. */
+ created?: components["schemas"]["DateDTO"];
+ /** @description A unique system generated ID for the organization. */
+ id?: string;
+ /** @description Name of the organization. */
+ name?: string;
+ };
+ OrganizationServiceDeskUpdateDTO: {
+ /**
+ * Format: int32
+ * @description List of organizations, specified by 'ID' field values, to add to or remove from the service desk.
+ */
+ organizationId: number;
+ /** @description Service desk Id for which, organization needs to be updated */
+ serviceDeskId?: string;
+ [key: string]: unknown;
+ };
+ /** @description A page of changelogs. */
+ PageOfChangelogs: {
+ /** @description The list of changelogs. */
+ histories?: readonly components["schemas"]["Changelog"][];
+ /**
+ * Format: int32
+ * @description The maximum number of results that could be on the page.
+ */
+ maxResults?: number;
+ /**
+ * Format: int32
+ * @description The index of the first item returned on the page.
+ */
+ startAt?: number;
+ /**
+ * Format: int32
+ * @description The number of results on the page.
+ */
+ total?: number;
+ };
+ PagedDTOApprovalDTO: {
+ _expands?: string[];
+ /** @description List of the links relating to the page. */
+ _links?: components["schemas"]["PagedLinkDTO"];
+ /** @description Indicates if this is the last page of records (true) or not (false). */
+ isLastPage?: boolean;
+ /**
+ * Format: int32
+ * @description Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
+ */
+ limit?: number;
+ /**
+ * Format: int32
+ * @description Number of items returned in the page.
+ */
+ size?: number;
+ /**
+ * Format: int32
+ * @description Index of the first item returned in the page.
+ */
+ start?: number;
+ /** @description Details of the items included in the page. */
+ values?: components["schemas"]["ApprovalDTO"][];
+ };
+ PagedDTOArticleDTO: {
+ _expands?: string[];
+ /** @description List of the links relating to the page. */
+ _links?: components["schemas"]["PagedLinkDTO"];
+ /** @description Indicates if this is the last page of records (true) or not (false). */
+ isLastPage?: boolean;
+ /**
+ * Format: int32
+ * @description Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
+ */
+ limit?: number;
+ /**
+ * Format: int32
+ * @description Number of items returned in the page.
+ */
+ size?: number;
+ /**
+ * Format: int32
+ * @description Index of the first item returned in the page.
+ */
+ start?: number;
+ /** @description Details of the items included in the page. */
+ values?: components["schemas"]["ArticleDTO"][];
+ };
+ PagedDTOAssetsWorkspaceDTO: {
+ _expands?: string[];
+ /** @description List of the links relating to the page. */
+ _links?: components["schemas"]["PagedLinkDTO"];
+ /** @description Indicates if this is the last page of records (true) or not (false). */
+ isLastPage?: boolean;
+ /**
+ * Format: int32
+ * @description Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
+ */
+ limit?: number;
+ /**
+ * Format: int32
+ * @description Number of items returned in the page.
+ */
+ size?: number;
+ /**
+ * Format: int32
+ * @description Index of the first item returned in the page.
+ */
+ start?: number;
+ /** @description Details of the items included in the page. */
+ values?: components["schemas"]["AssetsWorkspaceDTO"][];
+ };
+ PagedDTOAttachmentDTO: {
+ _expands?: string[];
+ /** @description List of the links relating to the page. */
+ _links?: components["schemas"]["PagedLinkDTO"];
+ /** @description Indicates if this is the last page of records (true) or not (false). */
+ isLastPage?: boolean;
+ /**
+ * Format: int32
+ * @description Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
+ */
+ limit?: number;
+ /**
+ * Format: int32
+ * @description Number of items returned in the page.
+ */
+ size?: number;
+ /**
+ * Format: int32
+ * @description Index of the first item returned in the page.
+ */
+ start?: number;
+ /** @description Details of the items included in the page. */
+ values?: components["schemas"]["AttachmentDTO"][];
+ };
+ PagedDTOCommentDTO: {
+ _expands?: string[];
+ /** @description List of the links relating to the page. */
+ _links?: components["schemas"]["PagedLinkDTO"];
+ /** @description Indicates if this is the last page of records (true) or not (false). */
+ isLastPage?: boolean;
+ /**
+ * Format: int32
+ * @description Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
+ */
+ limit?: number;
+ /**
+ * Format: int32
+ * @description Number of items returned in the page.
+ */
+ size?: number;
+ /**
+ * Format: int32
+ * @description Index of the first item returned in the page.
+ */
+ start?: number;
+ /** @description Details of the items included in the page. */
+ values?: components["schemas"]["CommentDTO"][];
+ };
+ PagedDTOCustomerRequestDTO: {
+ _expands?: string[];
+ /** @description List of the links relating to the page. */
+ _links?: components["schemas"]["PagedLinkDTO"];
+ /** @description Indicates if this is the last page of records (true) or not (false). */
+ isLastPage?: boolean;
+ /**
+ * Format: int32
+ * @description Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
+ */
+ limit?: number;
+ /**
+ * Format: int32
+ * @description Number of items returned in the page.
+ */
+ size?: number;
+ /**
+ * Format: int32
+ * @description Index of the first item returned in the page.
+ */
+ start?: number;
+ /** @description Details of the items included in the page. */
+ values?: components["schemas"]["CustomerRequestDTO"][];
+ };
+ PagedDTOCustomerRequestStatusDTO: {
+ _expands?: string[];
+ /** @description List of the links relating to the page. */
+ _links?: components["schemas"]["PagedLinkDTO"];
+ /** @description Indicates if this is the last page of records (true) or not (false). */
+ isLastPage?: boolean;
+ /**
+ * Format: int32
+ * @description Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
+ */
+ limit?: number;
+ /**
+ * Format: int32
+ * @description Number of items returned in the page.
+ */
+ size?: number;
+ /**
+ * Format: int32
+ * @description Index of the first item returned in the page.
+ */
+ start?: number;
+ /** @description Details of the items included in the page. */
+ values?: components["schemas"]["CustomerRequestStatusDTO"][];
+ };
+ PagedDTOCustomerTransitionDTO: {
+ _expands?: string[];
+ /** @description List of the links relating to the page. */
+ _links?: components["schemas"]["PagedLinkDTO"];
+ /** @description Indicates if this is the last page of records (true) or not (false). */
+ isLastPage?: boolean;
+ /**
+ * Format: int32
+ * @description Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
+ */
+ limit?: number;
+ /**
+ * Format: int32
+ * @description Number of items returned in the page.
+ */
+ size?: number;
+ /**
+ * Format: int32
+ * @description Index of the first item returned in the page.
+ */
+ start?: number;
+ /** @description Details of the items included in the page. */
+ values?: components["schemas"]["CustomerTransitionDTO"][];
+ };
+ PagedDTOInsightWorkspaceDTO: {
+ _expands?: string[];
+ /** @description List of the links relating to the page. */
+ _links?: components["schemas"]["PagedLinkDTO"];
+ /** @description Indicates if this is the last page of records (true) or not (false). */
+ isLastPage?: boolean;
+ /**
+ * Format: int32
+ * @description Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
+ */
+ limit?: number;
+ /**
+ * Format: int32
+ * @description Number of items returned in the page.
+ */
+ size?: number;
+ /**
+ * Format: int32
+ * @description Index of the first item returned in the page.
+ */
+ start?: number;
+ /** @description Details of the items included in the page. */
+ values?: components["schemas"]["InsightWorkspaceDTO"][];
+ };
+ PagedDTOIssueBean: {
+ _expands?: string[];
+ /** @description List of the links relating to the page. */
+ _links?: components["schemas"]["PagedLinkDTO"];
+ /** @description Indicates if this is the last page of records (true) or not (false). */
+ isLastPage?: boolean;
+ /**
+ * Format: int32
+ * @description Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
+ */
+ limit?: number;
+ /**
+ * Format: int32
+ * @description Number of items returned in the page.
+ */
+ size?: number;
+ /**
+ * Format: int32
+ * @description Index of the first item returned in the page.
+ */
+ start?: number;
+ /** @description Details of the items included in the page. */
+ values?: components["schemas"]["IssueBean"][];
+ };
+ PagedDTOOrganizationDTO: {
+ _expands?: string[];
+ /** @description List of the links relating to the page. */
+ _links?: components["schemas"]["PagedLinkDTO"];
+ /** @description Indicates if this is the last page of records (true) or not (false). */
+ isLastPage?: boolean;
+ /**
+ * Format: int32
+ * @description Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
+ */
+ limit?: number;
+ /**
+ * Format: int32
+ * @description Number of items returned in the page.
+ */
+ size?: number;
+ /**
+ * Format: int32
+ * @description Index of the first item returned in the page.
+ */
+ start?: number;
+ /** @description Details of the items included in the page. */
+ values?: components["schemas"]["OrganizationDTO"][];
+ };
+ PagedDTOQueueDTO: {
+ _expands?: string[];
+ /** @description List of the links relating to the page. */
+ _links?: components["schemas"]["PagedLinkDTO"];
+ /** @description Indicates if this is the last page of records (true) or not (false). */
+ isLastPage?: boolean;
+ /**
+ * Format: int32
+ * @description Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
+ */
+ limit?: number;
+ /**
+ * Format: int32
+ * @description Number of items returned in the page.
+ */
+ size?: number;
+ /**
+ * Format: int32
+ * @description Index of the first item returned in the page.
+ */
+ start?: number;
+ /** @description Details of the items included in the page. */
+ values?: components["schemas"]["QueueDTO"][];
+ };
+ PagedDTORequestTypeDTO: {
+ _expands?: string[];
+ /** @description List of the links relating to the page. */
+ _links?: components["schemas"]["PagedLinkDTO"];
+ /** @description Indicates if this is the last page of records (true) or not (false). */
+ isLastPage?: boolean;
+ /**
+ * Format: int32
+ * @description Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
+ */
+ limit?: number;
+ /**
+ * Format: int32
+ * @description Number of items returned in the page.
+ */
+ size?: number;
+ /**
+ * Format: int32
+ * @description Index of the first item returned in the page.
+ */
+ start?: number;
+ /** @description Details of the items included in the page. */
+ values?: components["schemas"]["RequestTypeDTO"][];
+ };
+ PagedDTORequestTypeGroupDTO: {
+ _expands?: string[];
+ /** @description List of the links relating to the page. */
+ _links?: components["schemas"]["PagedLinkDTO"];
+ /** @description Indicates if this is the last page of records (true) or not (false). */
+ isLastPage?: boolean;
+ /**
+ * Format: int32
+ * @description Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
+ */
+ limit?: number;
+ /**
+ * Format: int32
+ * @description Number of items returned in the page.
+ */
+ size?: number;
+ /**
+ * Format: int32
+ * @description Index of the first item returned in the page.
+ */
+ start?: number;
+ /** @description Details of the items included in the page. */
+ values?: components["schemas"]["RequestTypeGroupDTO"][];
+ };
+ PagedDTOServiceDeskDTO: {
+ _expands?: string[];
+ /** @description List of the links relating to the page. */
+ _links?: components["schemas"]["PagedLinkDTO"];
+ /** @description Indicates if this is the last page of records (true) or not (false). */
+ isLastPage?: boolean;
+ /**
+ * Format: int32
+ * @description Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
+ */
+ limit?: number;
+ /**
+ * Format: int32
+ * @description Number of items returned in the page.
+ */
+ size?: number;
+ /**
+ * Format: int32
+ * @description Index of the first item returned in the page.
+ */
+ start?: number;
+ /** @description Details of the items included in the page. */
+ values?: components["schemas"]["ServiceDeskDTO"][];
+ };
+ PagedDTOSlaInformationDTO: {
+ _expands?: string[];
+ /** @description List of the links relating to the page. */
+ _links?: components["schemas"]["PagedLinkDTO"];
+ /** @description Indicates if this is the last page of records (true) or not (false). */
+ isLastPage?: boolean;
+ /**
+ * Format: int32
+ * @description Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
+ */
+ limit?: number;
+ /**
+ * Format: int32
+ * @description Number of items returned in the page.
+ */
+ size?: number;
+ /**
+ * Format: int32
+ * @description Index of the first item returned in the page.
+ */
+ start?: number;
+ /** @description Details of the items included in the page. */
+ values?: components["schemas"]["SlaInformationDTO"][];
+ };
+ PagedDTOUserDTO: {
+ _expands?: string[];
+ /** @description List of the links relating to the page. */
+ _links?: components["schemas"]["PagedLinkDTO"];
+ /** @description Indicates if this is the last page of records (true) or not (false). */
+ isLastPage?: boolean;
+ /**
+ * Format: int32
+ * @description Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
+ */
+ limit?: number;
+ /**
+ * Format: int32
+ * @description Number of items returned in the page.
+ */
+ size?: number;
+ /**
+ * Format: int32
+ * @description Index of the first item returned in the page.
+ */
+ start?: number;
+ /** @description Details of the items included in the page. */
+ values?: components["schemas"]["UserDTO"][];
+ };
+ PagedLinkDTO: {
+ /**
+ * Format: uri
+ * @description Base URL for the REST API calls.
+ */
+ base?: string;
+ context?: string;
+ /**
+ * Format: uri
+ * @description REST API URL for the next page, if there is one.
+ */
+ next?: string;
+ /**
+ * Format: uri
+ * @description REST API URL for the previous page, if there is one.
+ */
+ prev?: string;
+ /**
+ * Format: uri
+ * @description REST API URL for the current page.
+ */
+ self?: string;
+ };
+ /** @description Details about a project. */
+ ProjectDetails: {
+ /** @description The URLs of the project's avatars. */
+ avatarUrls?: components["schemas"]["AvatarUrlsBean"];
+ /** @description The ID of the project. */
+ id?: string;
+ /** @description The key of the project. */
+ key?: string;
+ /** @description The name of the project. */
+ name?: string;
+ /** @description The category the project belongs to. */
+ projectCategory?: components["schemas"]["UpdatedProjectCategory"];
+ /**
+ * @description The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.
+ * @enum {string}
+ */
+ projectTypeKey?: "software" | "service_desk" | "business";
+ /** @description The URL of the project details. */
+ self?: string;
+ /** @description Whether or not the project is simplified. */
+ simplified?: boolean;
+ };
+ /** @description Property key details. */
+ PropertyKey: {
+ /** @description The key of the property. */
+ key?: string;
+ /** @description The URL of the property. */
+ self?: string;
+ };
+ /** @description List of property keys. */
+ PropertyKeys: {
+ /** @description Property key details. */
+ keys?: readonly components["schemas"]["PropertyKey"][];
+ };
+ QueueDTO: {
+ /** @description REST API URL to the queue. */
+ _links?: components["schemas"]["SelfLinkDTO"];
+ /** @description Fields returned for each request in the queue. */
+ fields?: string[];
+ /** @description ID for the queue. */
+ id?: string;
+ /**
+ * Format: int64
+ * @description The count of customer requests in the queue.
+ */
+ issueCount?: number;
+ /** @description JQL query that filters reqeusts for the queue. */
+ jql?: string;
+ /** @description Short name for the queue. */
+ name?: string;
+ };
+ RenderedValueDTO: {
+ html?: string;
+ };
+ RequestCreateDTO: {
+ /** @description (Experimental) Shows extra information for the request channel. */
+ channel?: string;
+ /** @description (Experimental) Provides answers to the form associated with a request type that is attached to the request on creation. Jira fields should be omitted from `requestFieldValues` if they are linked to form answers. Form answers in ADF format should have `isAdfRequest` set to true. Form answers are not currently validated. */
+ form?: components["schemas"]["Form"];
+ /** @description (Experimental) Whether to accept rich text fields in Atlassian Document Format (ADF). */
+ isAdfRequest?: boolean;
+ /** @description The `accountId` of the customer that the request is being raised on behalf of. */
+ raiseOnBehalfOf?: string;
+ /** @description JSON map of Jira field IDs and their values representing the content of the request. */
+ requestFieldValues?: {
+ [key: string]: unknown;
+ };
+ /** @description List of customers to participate in the request, as a list of `accountId` values. */
+ requestParticipants?: string[];
+ /** @description ID of the request type for the request. */
+ requestTypeId?: string;
+ /** @description ID of the service desk in which to create the request. */
+ serviceDeskId?: string;
+ };
+ RequestNotificationSubscriptionDTO: {
+ /** @description Indicates whether the user is subscribed (true) or not (false) to the request's notifications. */
+ subscribed?: boolean;
+ };
+ RequestParticipantUpdateDTO: {
+ /** @description List of users, specified by account IDs, to add to or remove as participants in the request. */
+ accountIds?: string[];
+ /** @description This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. Use `accountIds` instead. */
+ usernames?: string[];
+ };
+ RequestTypeCreateDTO: {
+ /** @description Description of the request type on the service desk. */
+ description?: string;
+ /** @description Help text for the request type on the service desk. */
+ helpText?: string;
+ /** @description ID of the request type to add to the service desk. */
+ issueTypeId?: string;
+ /** @description Name of the request type on the service desk. */
+ name?: string;
+ };
+ RequestTypeDTO: {
+ /** @description List of items that can be expanded in the response by specifying the expand query parameter. */
+ _expands?: string[];
+ /** @description REST API URL for the request type. */
+ _links?: components["schemas"]["SelfLinkDTO"];
+ /** @description Description of the request type. */
+ description?: string;
+ /** @description Fields and additional metadata for creating a request that uses the request type */
+ fields?: components["schemas"]["CustomerRequestCreateMetaDTO"];
+ /** @description List of the request type groups the request type belongs to. */
+ groupIds?: string[];
+ /** @description Help text for the request type. */
+ helpText?: string;
+ /** @description Links to the request type's icons. */
+ icon?: components["schemas"]["RequestTypeIconDTO"];
+ /** @description ID for the request type. */
+ id?: string;
+ /** @description ID of the issue type the request type is based upon. */
+ issueTypeId?: string;
+ /** @description Short name for the request type. */
+ name?: string;
+ /** @description ID of the customer portal associated with the service desk project. */
+ portalId?: string;
+ /** @description The request type's practice */
+ practice?: string;
+ /** @description ID of the service desk the request type belongs to. */
+ serviceDeskId?: string;
+ };
+ RequestTypeFieldDTO: {
+ /** @description List of default values for the field. */
+ defaultValues?: components["schemas"]["RequestTypeFieldValueDTO"][];
+ /** @description Description of the field. */
+ description?: string;
+ /** @description ID of the field. */
+ fieldId?: string;
+ /** @description Jira specific implementation details for the field in the UI. */
+ jiraSchema?: components["schemas"]["JsonTypeBean"];
+ /** @description Name of the field. */
+ name?: string;
+ /** @description List of preset values for the field. */
+ presetValues?: string[];
+ /** @description Indicates if the field is required (true) or not (false). */
+ required?: boolean;
+ /** @description List of valid values for the field. */
+ validValues?: components["schemas"]["RequestTypeFieldValueDTO"][];
+ visible?: boolean;
+ };
+ RequestTypeFieldValueDTO: {
+ /** @description List of child fields. */
+ children?: components["schemas"]["RequestTypeFieldValueDTO"][];
+ /** @description Label for the field. */
+ label?: string;
+ /** @description Value of the field. */
+ value?: string;
+ };
+ RequestTypeGroupDTO: {
+ /** @description ID of the request type group */
+ id?: string;
+ /** @description Name of the request type group. */
+ name?: string;
+ };
+ RequestTypeIconDTO: {
+ /** @description Map of the URLs for the request type icons. */
+ _links?: components["schemas"]["RequestTypeIconLinkDTO"];
+ /** @description ID of the request type icon. */
+ id?: string;
+ };
+ RequestTypeIconLinkDTO: {
+ /** @description URLs for the request type icons. */
+ iconUrls?: {
+ [key: string]: string;
+ };
+ };
+ Resource: {
+ description?: string;
+ /** Format: binary */
+ file?: string;
+ filename?: string;
+ inputStream?: Record;
+ open?: boolean;
+ readable?: boolean;
+ /** Format: uri */
+ uri?: string;
+ /** Format: url */
+ url?: string;
+ };
+ /** @description The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO). */
+ Scope: {
+ /** @description The project the item has scope in. */
+ project?: components["schemas"]["ProjectDetails"];
+ /**
+ * @description The type of scope.
+ * @enum {string}
+ */
+ type?: "PROJECT" | "TEMPLATE";
+ [key: string]: unknown;
+ };
+ SelfLinkDTO: {
+ /** Format: uri */
+ self?: string;
+ };
+ ServiceDeskCustomerDTO: {
+ /** @description List of users, specified by account IDs, to add to or remove from a service desk. */
+ accountIds?: string[];
+ /** @description This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. Use `accountIds` instead. */
+ usernames?: string[];
+ };
+ ServiceDeskDTO: {
+ /** @description REST API URL to the service desk. */
+ _links?: components["schemas"]["SelfLinkDTO"];
+ /** @description ID of the service desk. */
+ id?: string;
+ /** @description ID of the peer project for the service desk. */
+ projectId?: string;
+ /** @description Key of the peer project of the service desk. */
+ projectKey?: string;
+ /** @description Name of the project and service desk. */
+ projectName?: string;
+ };
+ /** @description Details about the operations available in this version. */
+ SimpleLink: {
+ href?: string;
+ iconClass?: string;
+ id?: string;
+ label?: string;
+ styleClass?: string;
+ title?: string;
+ /** Format: int32 */
+ weight?: number;
+ };
+ SlaInformationCompletedCycleDTO: {
+ /** @description Time and date at which the SLA cycle breached in case of completed breached cycle or would have breached in case of non-breached completed cycle. */
+ breachTime?: components["schemas"]["DateDTO"];
+ /** @description Indicates if the SLA (duration) was exceeded (true) or not (false). */
+ breached?: boolean;
+ /** @description Duration in which the service was completed. */
+ elapsedTime?: components["schemas"]["DurationDTO"];
+ /** @description Duration within which the service should have been completed. */
+ goalDuration?: components["schemas"]["DurationDTO"];
+ /** @description Duration remaining after the service was completed. */
+ remainingTime?: components["schemas"]["DurationDTO"];
+ /** @description Time and date at which the SLA cycle started. */
+ startTime?: components["schemas"]["DateDTO"];
+ /** @description Time and date at which the SLA cycle completed. */
+ stopTime?: components["schemas"]["DateDTO"];
+ };
+ SlaInformationDTO: {
+ /** @description REST API URL for the SLA. */
+ _links?: components["schemas"]["SelfLinkDTO"];
+ /** @description List of completed cycles for the SLA. */
+ completedCycles?: components["schemas"]["SlaInformationCompletedCycleDTO"][];
+ /** @description ID of the Service Level Agreement (SLA). */
+ id?: string;
+ /** @description Description of the SLA. */
+ name?: string;
+ /** @description Details of the active cycle for the SLA. */
+ ongoingCycle?: components["schemas"]["SlaInformationOngoingCycleDTO"];
+ /** @description Format in which SLA is to be displayed in the UI */
+ slaDisplayFormat?: string;
+ };
+ SlaInformationOngoingCycleDTO: {
+ /** @description Time and date at which the SLA cycle would have breached its limit. */
+ breachTime?: components["schemas"]["DateDTO"];
+ /** @description Indicates whether the SLA has been breached (true) or not (false). */
+ breached?: boolean;
+ /** @description Duration of the service. */
+ elapsedTime?: components["schemas"]["DurationDTO"];
+ /** @description Duration within which the service should be completed. */
+ goalDuration?: components["schemas"]["DurationDTO"];
+ /** @description Indicates whether the SLA is paused (true) or not (false). */
+ paused?: boolean;
+ /** @description Duration remaining in which to complete the service. */
+ remainingTime?: components["schemas"]["DurationDTO"];
+ /** @description Time and date at which the SLA cycle started. */
+ startTime?: components["schemas"]["DateDTO"];
+ /** @description Indicates whether the SLA it timed during calendared working hours only (true) or not (false). */
+ withinCalendarHours?: boolean;
+ };
+ SoftwareInfoDTO: {
+ /** @description REST API URL of the instance. */
+ _links?: components["schemas"]["SelfLinkDTO"];
+ /** @description Reference of the change set included in the build. */
+ buildChangeSet?: string;
+ /** @description Date of the current build. */
+ buildDate?: components["schemas"]["DateDTO"];
+ /** @description Indicates whether the instance is licensed (true) or not (false). */
+ isLicensedForUse?: boolean;
+ /** @description Jira Platform version upon which Service Desk is based. */
+ platformVersion?: string;
+ /** @description Jira Service Management version. */
+ version?: string;
+ };
+ SourceDTO: {
+ /**
+ * @description Type of the knowledge base source
+ * @enum {string}
+ */
+ type?: "confluence";
+ [key: string]: unknown;
+ };
+ /** @description A status category. */
+ StatusCategory: {
+ /** @description The name of the color used to represent the status category. */
+ colorName?: string;
+ /**
+ * Format: int64
+ * @description The ID of the status category.
+ */
+ id?: number;
+ /** @description The key of the status category. */
+ key?: string;
+ /** @description The name of the status category. */
+ name?: string;
+ /** @description The URL of the status category. */
+ self?: string;
+ [key: string]: unknown;
+ };
+ /** @description A status. */
+ StatusDetails: {
+ /** @description The description of the status. */
+ description?: string;
+ /** @description The URL of the icon used to represent the status. */
+ iconUrl?: string;
+ /** @description The ID of the status. */
+ id?: string;
+ /** @description The name of the status. */
+ name?: string;
+ /** @description The scope of the field. */
+ scope?: components["schemas"]["Scope"];
+ /** @description The URL of the status. */
+ self?: string;
+ /** @description The category assigned to the status. */
+ statusCategory?: components["schemas"]["StatusCategory"];
+ [key: string]: unknown;
+ };
+ /** @description A project category. */
+ UpdatedProjectCategory: {
+ /** @description The name of the project category. */
+ description?: string;
+ /** @description The ID of the project category. */
+ id?: string;
+ /** @description The description of the project category. */
+ name?: string;
+ /** @description The URL of the project category. */
+ self?: string;
+ };
+ UserDTO: {
+ /** @description URLs for the customer record and related items. */
+ _links?: components["schemas"]["UserLinkDTO"];
+ /** @description The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. */
+ accountId?: string;
+ /** @description Indicates if the customer is active (true) or inactive (false) */
+ active?: boolean;
+ /** @description Customer's name for display in a UI. Depending on the customer’s privacy settings, this may return an alternative value. */
+ displayName?: string;
+ /** @description Customer's email address. Depending on the customer’s privacy settings, this may be returned as null. */
+ emailAddress?: string;
+ /** @description This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. */
+ key?: string;
+ /** @description This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. */
+ name?: string;
+ /** @description Customer time zone. Depending on the customer’s privacy settings, this may be returned as null. */
+ timeZone?: string;
+ };
+ /**
+ * @description User details permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions:
+ *
+ * * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank).
+ * * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values.
+ * * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values.
+ */
+ UserDetails: {
+ /** @description The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. */
+ accountId?: string;
+ /** @description 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) */
+ accountType?: string;
+ /** @description Whether the user is active. */
+ active?: boolean;
+ /** @description The avatars of the user. */
+ avatarUrls?: components["schemas"]["AvatarUrlsBean"];
+ /** @description The display name of the user. Depending on the user’s privacy settings, this may return an alternative value. */
+ displayName?: string;
+ /** @description The email address of the user. Depending on the user’s privacy settings, this may be returned as null. */
+ emailAddress?: string;
+ /** @description This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. */
+ key?: string;
+ /** @description This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. */
+ name?: string;
+ /** @description The URL of the user. */
+ self?: string;
+ /** @description The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null. */
+ timeZone?: string;
+ };
+ UserLinkDTO: {
+ /** @description Links to the various sizes of the customer's avatar. Note that this property is deprecated, and will be removed in future versions. */
+ avatarUrls?: {
+ [key: string]: string;
+ };
+ /**
+ * Format: uri
+ * @description REST API URL for the customer.
+ */
+ jiraRest?: string;
+ /** Format: uri */
+ self?: string;
+ };
+ UsersOrganizationUpdateDTO: {
+ /** @description List of customers, specific by account IDs, to add to or remove from the organization. */
+ accountIds?: string[];
+ /**
+ * Format: int32
+ * @description The organizationId in which users need to be added
+ */
+ organizationId?: number;
+ /** @description This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. Use `accountIds` instead. */
+ usernames?: string[];
+ [key: string]: unknown;
+ };
+ };
+ responses: never;
+ parameters: never;
+ requestBodies: never;
+ headers: never;
+ pathItems: never;
+}
+
+export type $defs = Record;
+
+export type external = Record;
+
+export interface operations {
+ /**
+ * Get assets workspaces
+ * @description Returns a list of Assets workspace IDs. Include a workspace ID in the path to access the [Assets REST APIs](https://developer.atlassian.com/cloud/assets/rest).
+ *
+ * **[Permissions](#permissions) required**: Any
+ */
+ getAssetsWorkspaces: {
+ parameters: {
+ query?: {
+ /** @description The starting index of the returned workspace IDs. Base index: 0 See the [Pagination](#pagination) section for more details. */
+ start?: number;
+ /** @description The maximum number of workspace IDs to return per page. Default: 50 See the [Pagination](#pagination) section for more details. */
+ limit?: number;
+ };
+ };
+ responses: {
+ /** @description Returned if the request is successful. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["PagedDTOAssetsWorkspaceDTO"];
+ };
+ };
+ /** @description Returned if the authentication credentials are incorrect or missing. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have the necessary permission. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Create customer
+ * @description This method adds a customer to the Jira Service Management instance by passing a JSON file including an email address and display name. The display name does not need to be unique. The record's identifiers, `name` and `key`, are automatically generated from the request details.
+ *
+ * **[Permissions](#permissions) required**: Jira Administrator Global permission
+ */
+ createCustomer: {
+ parameters: {
+ query?: {
+ /** @description Optional boolean flag to return 409 Conflict status code for duplicate customer creation request */
+ strictConflictStatusCode?: boolean;
+ };
+ };
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "displayName": "Fred F. User",
+ * "email": "fred@example.com"
+ * }
+ */
+ "application/json": components["schemas"]["CustomerCreateDTO"];
+ };
+ };
+ responses: {
+ /** @description Returns the customer details. */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["UserDTO"];
+ };
+ };
+ /** @description Returned if the request is invalid, either because the email address is incorrectly formed or already exists in the database if `strictConflictStatusCode=false` or if `strictConflictStatusCode` parameter is not provided */
+ 400: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the request is invalid because the email address already exists in the database and `strictConflictStatusCode=true` */
+ 409: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get info
+ * @description This method retrieves information about the Jira Service Management instance such as software version, builds, and related links.
+ *
+ * **[Permissions](#permissions) required**: None, the user does not need to be logged in.
+ */
+ getInfo: {
+ responses: {
+ /** @description Returns the runtime information for the Jira Service Management instance. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["SoftwareInfoDTO"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get insight workspaces
+ * @description This endpoint is deprecated, please use /assets/workspace/.
+ */
+ getInsightWorkspaces: {
+ parameters: {
+ query?: {
+ start?: number;
+ limit?: number;
+ };
+ };
+ responses: {
+ /** @description 200 response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["PagedDTOInsightWorkspaceDTO"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get articles
+ * @description Returns articles which match the given query and belong to the knowledge base linked to the service desk.
+ *
+ * **[Permissions](#permissions) required**: Permission to access the service desk.
+ */
+ getArticles: {
+ parameters: {
+ query: {
+ /** @description The string used to filter the articles (required). */
+ query: string;
+ /** @description If set to true matching query term in the title and excerpt will be highlighted using the \{@code */
+ highlight?: boolean;
+ /** @description The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details. */
+ start?: number;
+ /** @description The maximum number of items to return per page. Default: 50. See the [Pagination](#pagination) section for more details. */
+ limit?: number;
+ };
+ path: {
+ serviceDeskId: string;
+ };
+ };
+ responses: {
+ /** @description Returns the articles, on the specified page of the results. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["PagedDTOArticleDTO"];
+ };
+ };
+ /** @description Returned if the request is invalid, for example: missing query parameter. */
+ 400: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get organizations
+ * @description This method returns a list of all organizations associated with a service desk.
+ *
+ * **[Permissions](#permissions) required**: Service desk's agent.
+ */
+ getOrganizations: {
+ parameters: {
+ query?: {
+ /** @description The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details. */
+ start?: number;
+ /** @description The maximum number of items to return per page. Default: 50. See the [Pagination](#pagination) section for more details. */
+ limit?: number;
+ /** @description The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. */
+ accountId?: string;
+ };
+ path: {
+ /** @description The ID of the service desk from which the organization list will be returned. This can alternatively be a [project identifier.](#project-identifiers) */
+ serviceDeskId: string;
+ };
+ };
+ responses: {
+ /** @description Returns the requested organizations list. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["PagedDTOOrganizationDTO"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if user does not have the necessary permission. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the service desk does not exist or the user is not found. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Create organization
+ * @description This method creates an organization by passing the name of the organization.
+ *
+ * **[Permissions](#permissions) required**: Service desk administrator or agent. Note: Permission to create organizations can be switched to users with the Jira administrator permission, using the **[Organization management](https://confluence.atlassian.com/servicedeskcloud/setting-up-service-desk-users-732528877.html#Settingupservicedeskusers-manageorgsManageorganizations)** feature.
+ */
+ createOrganization: {
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "name": "Charlie Cakes Franchises"
+ * }
+ */
+ "application/json": components["schemas"]["OrganizationCreateDTO"];
+ };
+ };
+ responses: {
+ /** @description Returns the created organization or the existing organization if name already exists. */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["OrganizationDTO"];
+ };
+ };
+ /** @description Returned if the HTTP request is invalid. */
+ 400: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get organization
+ * @description This method returns details of an organization. Use this method to get organization details whenever your application component is passed an organization ID but needs to display other organization details.
+ *
+ * **[Permissions](#permissions) required**: Any
+ *
+ * **Response limitations**: Customers can only retrieve organization of which they are members.
+ */
+ getOrganization: {
+ parameters: {
+ path: {
+ /** @description The ID of the organization. */
+ organizationId: number;
+ };
+ };
+ responses: {
+ /** @description Returns the requested organization. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["OrganizationDTO"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the organization does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Delete organization
+ * @description This method deletes an organization. Note that the organization is deleted regardless of other associations it may have. For example, associations with service desks.
+ *
+ * **[Permissions](#permissions) required**: Jira administrator.
+ */
+ deleteOrganization: {
+ parameters: {
+ path: {
+ /** @description The ID of the organization. */
+ organizationId: number;
+ };
+ };
+ responses: {
+ /** @description Returned if the organization was deleted. */
+ 204: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the organization does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get properties keys
+ * @description Returns the keys of all properties for a request type.
+ *
+ * Properties for a Request Type in next-gen are stored as Issue Type properties and therefore the keys of all properties for a request type are also available by calling the Jira Cloud Platform [Get issue type property keys](https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issuetype-issueTypeId-properties-get) endpoint.
+ *
+ * **[Permissions](#permissions) required**: The user must have permission to view the request type.
+ */
+ getPropertiesKeys: {
+ parameters: {
+ path: {
+ /** @description The ID of the request type for which keys will be retrieved. */
+ requestTypeId: number;
+ /** @description The ID of the service desk which contains the request type. This can alternatively be a [project identifier.](#project-identifiers) */
+ serviceDeskId: string;
+ };
+ };
+ responses: {
+ /** @description Returned if the request type was found. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["PropertyKeys"];
+ };
+ };
+ /** @description Returned if the request type ID is invalid. */
+ 400: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the request type does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get property
+ * @description Returns the value of the property from a request type.
+ *
+ * Properties for a Request Type in next-gen are stored as Issue Type properties and therefore also available by calling the Jira Cloud Platform [Get issue type property](https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issuetype-issueTypeId-properties-propertyKey-get) endpoint.
+ *
+ * **[Permissions](#permissions) required**: User must have permission to view the request type.
+ */
+ getProperty: {
+ parameters: {
+ path: {
+ /** @description The ID of the service desk which contains the request type. This can alternatively be a [project identifier.](#project-identifiers) */
+ serviceDeskId: string;
+ /** @description The ID of the request type from which the property will be retrieved. */
+ requestTypeId: number;
+ /** @description The key of the property to return. */
+ propertyKey: string;
+ };
+ };
+ responses: {
+ /** @description Returned if the request type property was returned. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["EntityProperty"];
+ };
+ };
+ /** @description Returned if the request type ID is invalid. */
+ 400: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the request type or property do not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Set property
+ * @description Sets the value of a request type property. Use this resource to store custom data against a request type.
+ *
+ * Properties for a Request Type in next-gen are stored as Issue Type properties and therefore can also be set by calling the Jira Cloud Platform [Set issue type property](https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issuetype-issueTypeId-properties-propertyKey-put) endpoint.
+ *
+ * **[Permissions](#permissions) required**: Jira project administrator with a Jira Service Management agent license.
+ */
+ setProperty: {
+ parameters: {
+ path: {
+ /** @description The ID of the service desk which contains the request type. This can alternatively be a [project identifier.](#project-identifiers) */
+ serviceDeskId: string;
+ /** @description The ID of the request type on which the property will be set. */
+ requestTypeId: number;
+ /** @description The key of the request type property. The maximum length of the key is 255 bytes. */
+ propertyKey: string;
+ };
+ };
+ responses: {
+ /** @description Returned if the request type property is updated. */
+ 200: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the request type property is created. */
+ 201: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the request type ID is invalid. */
+ 400: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the calling user doesn't have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the request type does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Delete property
+ * @description Removes a property from a request type.
+ *
+ * Properties for a Request Type in next-gen are stored as Issue Type properties and therefore can also be deleted by calling the Jira Cloud Platform [Delete issue type property](https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issuetype-issueTypeId-properties-propertyKey-delete) endpoint.
+ *
+ * **[Permissions](#permissions) required**: Jira project administrator with a Jira Service Management agent license.
+ */
+ deleteProperty: {
+ parameters: {
+ path: {
+ /** @description The ID of the service desk which contains the request type. This can alternatively be a [project identifier.](#project-identifiers) */
+ serviceDeskId: string;
+ /** @description The ID of the request type for which the property will be removed. */
+ requestTypeId: number;
+ /** @description The key of the property to remove. */
+ propertyKey: string;
+ };
+ };
+ responses: {
+ /** @description Returned if the request type property was removed. */
+ 204: {
+ content: never;
+ };
+ /** @description Returned if the request type ID is invalid. */
+ 400: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the calling user doesn't have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the request type or property do not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get users in organization
+ * @description This method returns all the users associated with an organization. Use this method where you want to provide a list of users for an organization or determine if a user is associated with an organization.
+ *
+ * **[Permissions](#permissions) required**: Service desk administrator or agent.
+ */
+ getUsersInOrganization: {
+ parameters: {
+ query?: {
+ /** @description The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details. */
+ start?: number;
+ /** @description The maximum number of users to return per page. Default: 50. See the [Pagination](#pagination) section for more details. */
+ limit?: number;
+ };
+ path: {
+ /** @description The ID of the organization. */
+ organizationId: number;
+ };
+ };
+ responses: {
+ /** @description Returns a paged list of users associated with the organization, ordered by their accountId. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["PagedDTOUserDTO"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the organization does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Add users to organization
+ * @description This method adds users to an organization.
+ *
+ * **[Permissions](#permissions) required**: Service desk administrator or agent. Note: Permission to add users to an organization can be switched to users with the Jira administrator permission, using the **[Organization management](https://confluence.atlassian.com/servicedeskcloud/setting-up-service-desk-users-732528877.html#Settingupservicedeskusers-manageorgsManageorganizations)** feature.
+ */
+ addUsersToOrganization: {
+ parameters: {
+ path: {
+ /** @description The ID of the organization. */
+ organizationId: number;
+ };
+ };
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "accountIds": [
+ * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
+ * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3a01db05e2a66fa80bd"
+ * ],
+ * "usernames": []
+ * }
+ */
+ "application/json": components["schemas"]["UsersOrganizationUpdateDTO"];
+ };
+ };
+ responses: {
+ /** @description Returned if all the users were valid and added to the organization, no response payload is provided. */
+ 204: {
+ content: never;
+ };
+ /** @description Returned if one or more usernames are unknown. */
+ 400: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the organization does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Remove users from organization
+ * @description This method removes users from an organization.
+ *
+ * **[Permissions](#permissions) required**: Service desk administrator or agent. Note: Permission to delete users from an organization can be switched to users with the Jira administrator permission, using the **[Organization management](https://confluence.atlassian.com/servicedeskcloud/setting-up-service-desk-users-732528877.html#Settingupservicedeskusers-manageorgsManageorganizations)** feature.
+ */
+ removeUsersFromOrganization: {
+ parameters: {
+ path: {
+ /** @description The ID of the organization. */
+ organizationId: number;
+ };
+ };
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "accountIds": [
+ * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
+ * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3a01db05e2a66fa80bd"
+ * ],
+ * "usernames": []
+ * }
+ */
+ "application/json": components["schemas"]["UsersOrganizationUpdateDTO"];
+ };
+ };
+ responses: {
+ /** @description The request completed successfully. No additional content will be sent in the response. */
+ 204: {
+ content: never;
+ };
+ /** @description Returned if one or more user names are invalid. */
+ 400: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the organization does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get customer requests
+ * @description This method returns all customer requests for the user executing the query.
+ *
+ * The returned customer requests are ordered chronologically by the latest activity on each request. For example, the latest status transition or comment.
+ *
+ * **[Permissions](#permissions) required**: Permission to access the specified service desk.
+ *
+ * **Response limitations**: For customers, the list returned will include request they created (or were created on their behalf) or are participating in only.
+ */
+ getCustomerRequests: {
+ parameters: {
+ query?: {
+ /** @description Filters customer requests where the request summary matches the `searchTerm`. [Wildcards](https://confluence.atlassian.com/display/JIRACORECLOUD/Search+syntax+for+text+fields) can be used in the `searchTerm` parameter. */
+ searchTerm?: string;
+ /**
+ * @description Filters customer requests using the following values:
+ *
+ * * `OWNED_REQUESTS` returns customer requests where the user is the creator.
+ * * `PARTICIPATED_REQUESTS` returns customer requests where the user is a participant.
+ * * `ORGANIZATION` returns customer requests for an organization of which the user is a member when used in conjunction with `organizationId`.
+ * * `ALL_ORGANIZATIONS` returns customer requests that belong to all organizations of which the user is a member.
+ * * `APPROVER` returns customer requests where the user is an approver. Can be used in conjunction with `approvalStatus` to filter pending or complete approvals.
+ * * `ALL_REQUESTS` returns all customer requests. **Deprecated and will be removed, as the returned requests may change if more values are added in the future. Instead, explicitly list the desired filtering strategies.**
+ *
+ * Multiple values of the query parameter are supported. For example, `requestOwnership=OWNED_REQUESTS&requestOwnership=PARTICIPATED_REQUESTS` will only return customer requests where the user is the creator or a participant. If not specified, filtering defaults to `OWNED_REQUESTS`, `PARTICIPATED_REQUESTS`, and `ALL_ORGANIZATIONS`.
+ */
+ requestOwnership?: string[];
+ /**
+ * @description Filters customer requests where the request is closed, open, or either of the two where:
+ *
+ * * `CLOSED_REQUESTS` returns customer requests that are closed.
+ * * `OPEN_REQUESTS` returns customer requests that are open.
+ * * `ALL_REQUESTS` returns all customer requests.
+ */
+ requestStatus?: string;
+ /**
+ * @description Filters results to customer requests based on their approval status:
+ *
+ * * `MY_PENDING_APPROVAL` returns customer requests pending the user's approval.
+ * * `MY_HISTORY_APPROVAL` returns customer requests where the user was an approver.
+ *
+ * **Note**: Valid only when used with requestOwnership=APPROVER.
+ */
+ approvalStatus?: string;
+ /** @description Filters customer requests that belong to a specific organization (note that the user must be a member of that organization). **Note**: Valid only when used with requestOwnership=ORGANIZATION. */
+ organizationId?: number;
+ /** @description Filters customer requests by service desk. */
+ serviceDeskId?: number;
+ /** @description Filters customer requests by request type. Note that the `serviceDeskId` must be specified for the service desk in which the request type belongs. */
+ requestTypeId?: number;
+ /**
+ * @description A multi-value parameter indicating which properties of the customer request to expand, where:
+ *
+ * * `serviceDesk` returns additional details for each service desk.
+ * * `requestType` returns additional details for each request type.
+ * * `participant` returns the participant details, if any, for each customer request.
+ * * `sla` returns the SLA information on each customer request.
+ * * `status` returns the status transitions, in chronological order, for each customer request.
+ * * `attachment` returns the attachments for the customer request.
+ * * `action` returns the actions that the user can or cannot perform on this customer request.
+ * * `comment` returns the comments, if any, for each customer request.
+ * * `comment.attachment` returns the attachment details, if any, for each comment.
+ * * `comment.renderedBody` (Experimental) returns the rendered body in HTML format (in addition to the raw body) for each comment.
+ */
+ expand?: string[];
+ /** @description The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details. */
+ start?: number;
+ /** @description The maximum number of items to return per page. Default: 50. See the [Pagination](#pagination) section for more details. */
+ limit?: number;
+ };
+ };
+ responses: {
+ /** @description Returns the customer requests, on the specified page of the results. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["PagedDTOCustomerRequestDTO"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to access the service desk, the service desk does not exist, or the service desk does not support the request type. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Create customer request
+ * @description This method creates a customer request in a service desk.
+ *
+ * The JSON request must include the service desk and customer request type, as well as any fields that are required for the request type. A list of the fields required by a customer request type can be obtained using [servicedesk/\{serviceDeskId\}/requesttype/\{requestTypeId\}/field](#api-servicedesk-serviceDeskId-requesttype-requestTypeId-field-get).
+ *
+ * The fields required for a customer request type depend on the user's permissions:
+ *
+ * * `raiseOnBehalfOf` is not available to Users who have the customer permission only.
+ * * `requestParticipants` is not available to Users who have the customer permission only or if the feature is turned off for customers.
+ *
+ * `requestFieldValues` is a map of Jira field IDs and their values. See [Field input formats](#fieldformats), for details of each field's JSON semantics and the values they can take.
+ *
+ * **[Permissions](#permissions) required**: Permission to create requests in the specified service desk.
+ */
+ createCustomerRequest: {
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "form": {
+ * "answers": {
+ * "1": {
+ * "text": "Answer to a text form field"
+ * },
+ * "2": {
+ * "date": "2023-07-06"
+ * },
+ * "3": {
+ * "time": "14:35"
+ * },
+ * "4": {
+ * "choices": [
+ * "5"
+ * ]
+ * },
+ * "5": {
+ * "users": [
+ * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d69abfa3980ce712caae"
+ * ]
+ * }
+ * }
+ * },
+ * "isAdfRequest": false,
+ * "requestFieldValues": {
+ * "description": "I need a new *mouse* for my Mac",
+ * "summary": "Request JSD help via REST"
+ * },
+ * "requestParticipants": [
+ * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d69abfa3980ce712caae"
+ * ],
+ * "requestTypeId": "25",
+ * "serviceDeskId": "10"
+ * }
+ */
+ "application/json": components["schemas"]["RequestCreateDTO"];
+ };
+ };
+ responses: {
+ /** @description Returned if the customer request was created. */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["CustomerRequestDTO"];
+ };
+ };
+ /** @description Returned if the HTTP request call is invalid. */
+ 400: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get customer request by id or key
+ * @description This method returns a customer request.
+ *
+ * **[Permissions](#permissions) required**: Permission to access the specified service desk.
+ *
+ * **Response limitations**: For customers, only a request they created, was created on their behalf, or they are participating in will be returned.
+ *
+ * **Note:** `requestFieldValues` does not include hidden fields. To get a list of request type fields that includes hidden fields, see [/rest/servicedeskapi/servicedesk/\{serviceDeskId\}/requesttype/\{requestTypeId\}/field](https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk/#api-rest-servicedeskapi-servicedesk-servicedeskid-requesttype-requesttypeid-field-get)
+ */
+ getCustomerRequestByIdOrKey: {
+ parameters: {
+ query?: {
+ /**
+ * @description A multi-value parameter indicating which properties of the customer request to expand, where:
+ *
+ * * `serviceDesk` returns additional service desk details.
+ * * `requestType` returns additional customer request type details.
+ * * `participant` returns the participant details.
+ * * `sla` returns the SLA information.
+ * * `status` returns the status transitions, in chronological order.
+ * * `attachment` returns the attachments.
+ * * `action` returns the actions that the user can or cannot perform.
+ * * `comment` returns the comments.
+ * * `comment.attachment` returns the attachment details for each comment.
+ * * `comment.renderedBody` (Experimental) return the rendered body in HTML format (in addition to the raw body) for each comment.
+ */
+ expand?: string[];
+ };
+ path: {
+ /** @description The ID or Key of the customer request to be returned */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Returns the customer request. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["CustomerRequestDTO"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the customer request does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get approvals
+ * @description This method returns all approvals on a customer request.
+ *
+ * **[Permissions](#permissions) required**: Permission to view the customer request.
+ */
+ getApprovals: {
+ parameters: {
+ query?: {
+ /** @description The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details. */
+ start?: number;
+ /** @description The maximum number of approvals to return per page. Default: 50. See the [Pagination](#pagination) section for more details. */
+ limit?: number;
+ };
+ path: {
+ /** @description The ID or key of the customer request to be queried for its approvals. */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Returns the customer request's approvals. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["PagedDTOApprovalDTO"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the customer request does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get approval by id
+ * @description This method returns an approval. Use this method to determine the status of an approval and the list of approvers.
+ *
+ * **[Permissions](#permissions) required**: Permission to view the customer request.
+ */
+ getApprovalById: {
+ parameters: {
+ path: {
+ /** @description The ID or key of the customer request the approval is on. */
+ issueIdOrKey: string;
+ /** @description The ID of the approval to be returned. */
+ approvalId: number;
+ };
+ };
+ responses: {
+ /** @description Returns the requested approval. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["ApprovalDTO"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the customer request or approval do not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Answer approval
+ * @description This method enables a user to **Approve** or **Decline** an approval on a customer request. The approval is assumed to be owned by the user making the call.
+ *
+ * **[Permissions](#permissions) required**: User is assigned to the approval request.
+ */
+ answerApproval: {
+ parameters: {
+ path: {
+ /** @description The ID or key of the customer request to be updated. */
+ issueIdOrKey: string;
+ /** @description The ID of the approval to be updated. */
+ approvalId: number;
+ };
+ };
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "decision": "approve"
+ * }
+ */
+ "application/json": components["schemas"]["ApprovalDecisionRequestDTO"];
+ };
+ };
+ responses: {
+ /** @description Returns the updated approval. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["ApprovalDTO"];
+ };
+ };
+ /** @description Returned if the request is not valid. */
+ 400: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the customer request or the approval do not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the customer has already submitted a decision or the approval has already been completed. */
+ 409: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get attachments for request
+ * @description This method returns all the attachments for a customer requests.
+ *
+ * **[Permissions](#permissions) required**: Permission to view the customer request.
+ *
+ * **Response limitations**: Customers will only get a list of public attachments.
+ */
+ getAttachmentsForRequest: {
+ parameters: {
+ query: {
+ /** @description The starting index of the returned attachment. Base index: 0. See the [Pagination](#pagination) section for more details. */
+ start: number;
+ /** @description The maximum number of comments to return per page. Default: 50. See the [Pagination](#pagination) section for more details. */
+ limit: number;
+ };
+ path: {
+ /** @description The ID or key of the customer request from which the attachments will be listed. */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Returns the visible attachments from the customer request. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["PagedDTOAttachmentDTO"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the customer request does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Create comment with attachment
+ * @description This method creates a comment on a customer request using one or more attachment files (uploaded using [servicedeskapi/servicedesk/\{serviceDeskId\}/attachTemporaryFile](https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk/#api-rest-servicedeskapi-servicedesk-servicedeskid-attachtemporaryfile-post)), with the visibility set by `public`. See
+ *
+ * * GET [servicedeskapi/request/\{issueIdOrKey\}/attachment](./#api-rest-servicedeskapi-request-issueidorkey-attachment-get)
+ * * GET [servicedeskapi/request/\{issueIdOrKey\}/comment/\{commentId\}/attachment](./#api-rest-servicedeskapi-request-issueidorkey-comment-commentid-attachment-get)
+ *
+ * **[Permissions](#permissions) required**: Permission to add an attachment.
+ *
+ * **Request limitations**: Customers can set public visibility only.
+ */
+ createCommentWithAttachment: {
+ parameters: {
+ path: {
+ /** @description The ID or key of the customer request to which the attachment will be added. */
+ issueIdOrKey: string;
+ };
+ };
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "additionalComment": {
+ * "body": "Please find the screenshot and the log file attached."
+ * },
+ * "public": true,
+ * "temporaryAttachmentIds": [
+ * "temp910441317820424274",
+ * "temp3600755449679003114"
+ * ]
+ * }
+ */
+ "application/json": components["schemas"]["AttachmentCreateDTO"];
+ };
+ };
+ responses: {
+ /** @description Returns the attachments and comment. */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["AttachmentCreateResultDTO"];
+ };
+ };
+ /** @description Returned if the HTTP request is invalid, including missing the required `public` field or list of temporary file IDs, or if the temporary files have expired. */
+ 400: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the customer request does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get attachment content
+ * @description Returns the contents of an attachment.
+ *
+ * To return a thumbnail of the attachment, use [servicedeskapi/request/\{issueIdOrKey\}/attachment/\{attachmentId\}/thumbnail](./#api-rest-servicedeskapi-request-issueidorkey-attachment-attachmentid-thumbnail-get).
+ *
+ * **[Permissions](#permissions) required:** For the issue containing the attachment:
+ *
+ * * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
+ * * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
+ */
+ getAttachmentContent: {
+ parameters: {
+ path: {
+ /** @description The ID or key for the customer request the attachment is associated with */
+ issueIdOrKey: string;
+ /** @description The ID for the attachment */
+ attachmentId: number;
+ };
+ };
+ responses: {
+ /** @description 200 response */
+ 200: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the request is successful. See the `Location` header for the download URL. */
+ 303: {
+ content: never;
+ };
+ /** @description Returned if the authentication credentials are incorrect. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description The user does not have the necessary permission. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /**
+ * @description Returned if:
+ *
+ * * the attachment is not found.
+ * * attachments are disabled in the Jira settings.
+ */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get attachment thumbnail
+ * @description Returns the thumbnail of an attachment.
+ *
+ * To return the attachment contents, use [servicedeskapi/request/\{issueIdOrKey\}/attachment/\{attachmentId\}](#api-rest-servicedeskapi-request-issueidorkey-attachment-attachmentid-get).
+ *
+ * **[Permissions](#permissions) required:** For the issue containing the attachment:
+ *
+ * * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
+ * * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue.
+ */
+ getAttachmentThumbnail: {
+ parameters: {
+ path: {
+ /** @description The ID or key for the customer request the attachment is associated with */
+ issueIdOrKey: string;
+ /** @description The ID of the attachment. */
+ attachmentId: number;
+ };
+ };
+ responses: {
+ /** @description 200 response */
+ 200: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the request is successful. See the `Location` header for the download URL. */
+ 303: {
+ content: never;
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the authentication credentials are incorrect. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description The user does not have the necessary permission. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /**
+ * @description Returned if:
+ *
+ * * the attachment is not found.
+ * * attachments are disabled in the Jira settings.
+ */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get request comments
+ * @description This method returns all comments on a customer request. No permissions error is provided if, for example, the user doesn't have access to the service desk or request, the method simply returns an empty response.
+ *
+ * **[Permissions](#permissions) required**: Permission to view the customer request.
+ *
+ * **Response limitations**: Customers are returned public comments only.
+ */
+ getRequestComments: {
+ parameters: {
+ query?: {
+ /** @description Specifies whether to return public comments or not. Default: true. */
+ public?: boolean;
+ /** @description Specifies whether to return internal comments or not. Default: true. */
+ internal?: boolean;
+ /**
+ * @description A multi-value parameter indicating which properties of the comment to expand:
+ *
+ * * `attachment` returns the attachment details, if any, for each comment. (If you want to get all attachments for a request, use [servicedeskapi/request/\{issueIdOrKey\}/attachment](#api-request-issueIdOrKey-attachment-get).)
+ * * `renderedBody` (Experimental) returns the rendered body in HTML format (in addition to the raw body) for each comment.
+ */
+ expand?: string[];
+ /** @description The starting index of the returned comments. Base index: 0. See the [Pagination](#pagination) section for more details. */
+ start?: number;
+ /** @description The maximum number of comments to return per page. Default: 50. See the [Pagination](#pagination) section for more details. */
+ limit?: number;
+ };
+ path: {
+ /** @description The ID or key of the customer request whose comments will be retrieved. */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Returns the comments, on the specified page of the results. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["PagedDTOCommentDTO"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the customer request does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Create request comment
+ * @description This method creates a public or private (internal) comment on a customer request, with the comment visibility set by `public`. The user recorded as the author of the comment.
+ *
+ * **[Permissions](#permissions) required**: User has Add Comments permission.
+ *
+ * **Request limitations**: Customers can set comments to public visibility only.
+ */
+ createRequestComment: {
+ parameters: {
+ path: {
+ /** @description The ID or key of the customer request to which the comment will be added. */
+ issueIdOrKey: string;
+ };
+ };
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "body": "Hello there",
+ * "public": true
+ * }
+ */
+ "application/json": components["schemas"]["CommentCreateDTO"];
+ };
+ };
+ responses: {
+ /** @description Returns the comment. */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["CommentDTO"];
+ };
+ };
+ /** @description Returned if the HTTP request is invalid, e.g. missing the required `public`. */
+ 400: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the customer request does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get request comment by id
+ * @description This method returns details of a customer request's comment.
+ *
+ * **[Permissions](#permissions) required**: Permission to view the customer request.
+ *
+ * **Response limitations**: Customers can only view public comments on requests where they are the reporter or a participant whereas agents can see both internal and public comments.
+ */
+ getRequestCommentById: {
+ parameters: {
+ query?: {
+ /**
+ * @description A multi-value parameter indicating which properties of the comment to expand:
+ *
+ * * `attachment` returns the attachment details, if any, for the comment. (If you want to get all attachments for a request, use [servicedeskapi/request/\{issueIdOrKey\}/attachment](#api-request-issueIdOrKey-attachment-get).)
+ * * `renderedBody` (Experimental) returns the rendered body in HTML format (in addition to the raw body) of the comment.
+ */
+ expand?: string[];
+ };
+ path: {
+ /** @description The ID or key of the customer request that contains the comment. */
+ issueIdOrKey: string;
+ /** @description The ID of the comment to retrieve. */
+ commentId: number;
+ };
+ };
+ responses: {
+ /** @description Returns the comment. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["CommentDTO"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the customer request or comment do not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get comment attachments
+ * @description This method returns the attachments referenced in a comment.
+ *
+ * **[Permissions](#permissions) required**: Permission to view the customer request.
+ *
+ * **Response limitations**: Customers can only view public comments, and retrieve their attachments, on requests where they are the reporter or a participant whereas agents can see both internal and public comments.
+ */
+ getCommentAttachments: {
+ parameters: {
+ query?: {
+ /** @description The starting index of the returned comments. Base index: 0. See the [Pagination](#pagination) section for more details. */
+ start?: number;
+ /** @description The maximum number of comments to return per page. Default: 50. See the [Pagination](#pagination) section for more details. */
+ limit?: number;
+ };
+ path: {
+ /** @description The ID or key of the customer request that contains the comment. */
+ issueIdOrKey: string;
+ /** @description The ID of the comment. */
+ commentId: number;
+ };
+ };
+ responses: {
+ /** @description Returns the attachments, on the specified page of the results. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["PagedDTOAttachmentDTO"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the customer request or the comment do not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get subscription status
+ * @description This method returns the notification subscription status of the user making the request. Use this method to determine if the user is subscribed to a customer request's notifications.
+ *
+ * **[Permissions](#permissions) required**: Permission to view the customer request.
+ */
+ getSubscriptionStatus: {
+ parameters: {
+ path: {
+ /** @description The ID or key of the customer request to be queried for subscription status. */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Returns the status of the notification subscription. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["RequestNotificationSubscriptionDTO"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the customer request does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Subscribe
+ * @description This method subscribes the user to receiving notifications from a customer request.
+ *
+ * **[Permissions](#permissions) required**: Permission to view the customer request.
+ */
+ subscribe: {
+ parameters: {
+ path: {
+ /** @description The ID or key of the customer request to be subscribed to. */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Returns if the user was subscribed. */
+ 204: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the customer request does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Unsubscribe
+ * @description This method unsubscribes the user from notifications from a customer request.
+ *
+ * **[Permissions](#permissions) required**: Permission to view the customer request.
+ */
+ unsubscribe: {
+ parameters: {
+ path: {
+ /** @description The ID or key of the customer request to be unsubscribed from. */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Returns if the user was unsubscribed. */
+ 204: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the customer request does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get request participants
+ * @description This method returns a list of all the participants on a customer request.
+ *
+ * **[Permissions](#permissions) required**: Permission to view the customer request.
+ */
+ getRequestParticipants: {
+ parameters: {
+ query?: {
+ /** @description The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details. */
+ start?: number;
+ /** @description The maximum number of request types to return per page. Default: 50. See the [Pagination](#pagination) section for more details. */
+ limit?: number;
+ };
+ path: {
+ /** @description The ID or key of the customer request to be queried for its participants. */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Returns the customer request's participants, on the specified page of the results. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["PagedDTOUserDTO"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the customer request does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Add request participants
+ * @description This method adds participants to a customer request.
+ *
+ * **[Permissions](#permissions) required**: Permission to manage participants on the customer request.
+ *
+ * Note, participants can be added when creating a customer request using the [request](#api-request-post) resource, by defining the participants in the `requestParticipants` field.
+ */
+ addRequestParticipants: {
+ parameters: {
+ path: {
+ /** @description The ID or key of the customer request to have participants added. */
+ issueIdOrKey: string;
+ };
+ };
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "accountIds": [],
+ * "usernames": [
+ * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
+ * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3a01db05e2a66fa80bd",
+ * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d69abfa3980ce712caae"
+ * ]
+ * }
+ */
+ "application/json": components["schemas"]["RequestParticipantUpdateDTO"];
+ };
+ };
+ responses: {
+ /** @description Returns the participants added to the customer request. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["PagedDTOUserDTO"];
+ };
+ };
+ /** @description Returned if any user to be added as a participant does not exist. */
+ 400: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the customer request does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Remove request participants
+ * @description This method removes participants from a customer request.
+ *
+ * **[Permissions](#permissions) required**: Permission to manage participants on the customer request.
+ */
+ removeRequestParticipants: {
+ parameters: {
+ path: {
+ /** @description The ID or key of the customer request to have participants removed. */
+ issueIdOrKey: string;
+ };
+ };
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "accountIds": [],
+ * "usernames": [
+ * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
+ * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3a01db05e2a66fa80bd",
+ * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d69abfa3980ce712caae"
+ * ]
+ * }
+ */
+ "application/json": components["schemas"]["RequestParticipantUpdateDTO"];
+ };
+ };
+ responses: {
+ /** @description Returns the first page of the customer request's participants (after removal of the users). */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["PagedDTOUserDTO"];
+ };
+ };
+ /** @description Returned if any user to be removed as a participant does not exist, is not a participant in the customer request, or is the reporter of the request. */
+ 400: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the customer request does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get sla information
+ * @description This method returns all the SLA records on a customer request. A customer request can have zero or more SLAs. Each SLA can have recordings for zero or more "completed cycles" and zero or 1 "ongoing cycle". Each cycle includes information on when it started and stopped, and whether it breached the SLA goal.
+ *
+ * **[Permissions](#permissions) required**: Agent for the Service Desk containing the queried customer request.
+ */
+ getSlaInformation: {
+ parameters: {
+ query?: {
+ /** @description The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details. */
+ start?: number;
+ /** @description The maximum number of request types to return per page. Default: 50. See the [Pagination](#pagination) section for more details. */
+ limit?: number;
+ };
+ path: {
+ /** @description The ID or key of the customer request whose SLAs will be retrieved. */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Returns the SLA records on the customer request, on the specified page of the results. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["PagedDTOSlaInformationDTO"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the customer request does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get sla information by id
+ * @description This method returns the details for an SLA on a customer request.
+ *
+ * **[Permissions](#permissions) required**: Agent for the Service Desk containing the queried customer request.
+ */
+ getSlaInformationById: {
+ parameters: {
+ path: {
+ /** @description The ID or key of the customer request whose SLAs will be retrieved. */
+ issueIdOrKey: string;
+ /** @description The ID or key of the SLAs metric to be retrieved. */
+ slaMetricId: number;
+ };
+ };
+ responses: {
+ /** @description Returns the SLA record, on the specified page of the results. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["SlaInformationDTO"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the customer request does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get customer request status
+ * @description This method returns a list of all the statuses a customer Request has achieved. A status represents the state of an issue in its workflow. An issue can have one active status only. The list returns the status history in chronological order, most recent (current) status first.
+ *
+ * **[Permissions](#permissions) required**: Permission to view the customer request.
+ */
+ getCustomerRequestStatus: {
+ parameters: {
+ query?: {
+ /** @description The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details. */
+ start?: number;
+ /** @description The maximum number of items to return per page. Default: 50. See the [Pagination](#pagination) section for more details. */
+ limit?: number;
+ };
+ path: {
+ /** @description The ID or key of the customer request to be retrieved. */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Returns the customer request's status history, on the specified page of the results. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["PagedDTOCustomerRequestStatusDTO"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the customer request is not found. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get customer transitions
+ * @description This method returns a list of transitions, the workflow processes that moves a customer request from one status to another, that the user can perform on a request. Use this method to provide a user with a list if the actions they can take on a customer request.
+ *
+ * **[Permissions](#permissions) required**: Permission to view the customer request.
+ */
+ getCustomerTransitions: {
+ parameters: {
+ query?: {
+ /** @description The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details. */
+ start?: number;
+ /** @description The maximum number of items to return per page. Default: 50. See the [Pagination](#pagination) section for more details. */
+ limit?: number;
+ };
+ path: {
+ /** @description The ID or key of the customer request whose transitions will be retrieved. */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Returns the transitions available to the user on the customer request. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["PagedDTOCustomerTransitionDTO"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the customer request does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Perform customer transition
+ * @description This method performs a customer transition for a given request and transition. An optional comment can be included to provide a reason for the transition.
+ *
+ * **[Permissions](#permissions) required**: The user must be able to view the request and have the Transition Issues permission. If a comment is passed the user must have the Add Comments permission.
+ */
+ performCustomerTransition: {
+ parameters: {
+ path: {
+ /** @description ID or key of the issue to transition */
+ issueIdOrKey: string;
+ };
+ };
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "additionalComment": {
+ * "body": "I have fixed the problem."
+ * },
+ * "id": "1"
+ * }
+ */
+ "application/json": components["schemas"]["CustomerTransitionExecutionDTO"];
+ };
+ };
+ responses: {
+ /** @description Returned if the request is transitioned. */
+ 204: {
+ content: never;
+ };
+ /** @description Returned if the transition ID is invalid or the comment is too long. */
+ 400: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the request does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get feedback
+ * @description This method retrieves a feedback of a request using it's `requestKey` or `requestId`
+ *
+ * **[Permissions](#permissions) required**: User has view request permissions.
+ */
+ getFeedback: {
+ parameters: {
+ path: {
+ /** @description The id or the key of the request to post the feedback on */
+ requestIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Returns the comment. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["CSATFeedbackFullDTO"];
+ };
+ };
+ /** @description Returned if the HTTP request is invalid. */
+ 400: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if no logged in user/app. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user/app does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the customer request does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Post feedback
+ * @description This method adds a feedback on an request using it's `requestKey` or `requestId`
+ *
+ * **[Permissions](#permissions) required**: User must be the reporter or an Atlassian Connect app.
+ */
+ postFeedback: {
+ parameters: {
+ path: {
+ /** @description The id or the key of the request to post the feedback on */
+ requestIdOrKey: string;
+ };
+ };
+ /** @description The feedback to be added on the request */
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "comment": {
+ * "body": "Great work!"
+ * },
+ * "rating": 4,
+ * "type": "csat"
+ * }
+ */
+ "application/json": components["schemas"]["CSATFeedbackFullDTO"];
+ };
+ };
+ responses: {
+ /** @description Returns the comment. */
+ 201: {
+ content: {
+ "application/json": components["schemas"]["CSATFeedbackFullDTO"];
+ };
+ };
+ /** @description Returned if the HTTP request is invalid. */
+ 400: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if no logged in user/app. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user/app does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the customer request does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Delete feedback
+ * @description This method deletes the feedback of request using it's `requestKey` or `requestId`
+ *
+ * **[Permissions](#permissions) required**: User must be the reporter or an Atlassian Connect app.
+ */
+ deleteFeedback: {
+ parameters: {
+ path: {
+ /** @description The id or the key of the request to post the feedback on */
+ requestIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description No content. */
+ 204: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if no logged in user/app. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user/app does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the customer request does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get all request types
+ * @description This method returns all customer request types used in the Jira Service Management instance, optionally filtered by a query string.
+ *
+ * Use [servicedeskapi/servicedesk/\{serviceDeskId\}/requesttype](#api-servicedesk-serviceDeskId-requesttype-get) to find the customer request types supported by a specific service desk.
+ *
+ * The returned list of customer request types can be filtered using the `query` parameter. The parameter is matched against the customer request types' `name` or `description`. For example, searching for "Install", "Inst", "Equi", or "Equipment" will match a customer request type with the *name* "Equipment Installation Request".
+ *
+ * **Note:** This API will filter out hidden request types (aka.request types without groups) when `query` is provided.
+ *
+ * **[Permissions](#permissions) required**: Any
+ */
+ getAllRequestTypes: {
+ parameters: {
+ query?: {
+ /** @description String to be used to filter the results. */
+ searchQuery?: string;
+ /** @description Filter the request types by service desk Ids provided. Multiple values of the query parameter are supported. For example, `serviceDeskId=1&serviceDeskId=2` will return request types only for service desks 1 and 2. */
+ serviceDeskId?: number[];
+ /** @description The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details. */
+ start?: number;
+ /** @description The maximum number of items to return per page. Default: 50. See the [Pagination](#pagination) section for more details. */
+ limit?: number;
+ expand?: string[];
+ };
+ };
+ responses: {
+ /** @description Returns the request types, on the specified page of the results. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["PagedDTORequestTypeDTO"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get service desks
+ * @description This method returns all the service desks in the Jira Service Management instance that the user has permission to access. Use this method where you need a list of service desks or need to locate a service desk by name or keyword.
+ *
+ * **Note:** This method will be slow if the instance has hundreds of service desks. If you want to fetch a single service desk by its ID, use [/rest/servicedeskapi/servicedesk/\{serviceDeskId\}](./#api-rest-servicedeskapi-servicedesk-servicedeskid-get) instead.
+ *
+ * **[Permissions](#permissions) required**: Any
+ */
+ getServiceDesks: {
+ parameters: {
+ query?: {
+ /** @description The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details. */
+ start?: number;
+ /** @description The maximum number of items to return per page. Default: 50. See the [Pagination](#pagination) section for more details. */
+ limit?: number;
+ };
+ };
+ responses: {
+ /** @description Returns the service desks, on the specified page of the results. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["PagedDTOServiceDeskDTO"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get service desk by id
+ * @description This method returns a service desk. Use this method to get service desk details whenever your application component is passed a service desk ID but needs to display other service desk details.
+ *
+ * **[Permissions](#permissions) required**: Permission to access the Service Desk. For example, being the Service Desk's Administrator or one of its Agents or Users.
+ */
+ getServiceDeskById: {
+ parameters: {
+ path: {
+ /** @description The ID of the service desk to return. This can alternatively be a [project identifier.](#project-identifiers) */
+ serviceDeskId: string;
+ };
+ };
+ responses: {
+ /** @description Returns the requested service desk. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["ServiceDeskDTO"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if service desk does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Attach temporary file
+ * @description This method adds one or more temporary attachments to a service desk, which can then be permanently attached to a customer request using [servicedeskapi/request/\{issueIdOrKey\}/attachment](#api-request-issueIdOrKey-attachment-post).
+ *
+ * **Note**: It is possible for a service desk administrator to turn off the ability to add attachments to a service desk.
+ *
+ * This method expects a multipart request. The media-type multipart/form-data is defined in RFC 1867. Most client libraries have classes that make dealing with multipart posts simple. For instance, in Java the Apache HTTP Components library provides [MultiPartEntity](http://hc.apache.org/httpcomponents-client-ga/httpmime/apidocs/org/apache/http/entity/mime/MultipartEntity.html).
+ *
+ * Because this method accepts multipart/form-data, it has XSRF protection on it. This means you must submit a header of X-Atlassian-Token: no-check with the request or it will be blocked.
+ *
+ * The name of the multipart/form-data parameter that contains the attachments must be `file`.
+ *
+ * For example, to upload a file called `myfile.txt` in the Service Desk with ID 10001 use
+ *
+ * curl -D- -u customer:customer -X POST -H "X-ExperimentalApi: opt-in" -H "X-Atlassian-Token: no-check" -F "file=@myfile.txt" https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/10001/attachTemporaryFile
+ *
+ * **[Permissions](#permissions) required**: Permission to add attachments in this Service Desk.
+ */
+ attachTemporaryFile: {
+ parameters: {
+ path: {
+ /** @description The ID of the Service Desk to which the file will be attached. This can alternatively be a [project identifier.](#project-identifiers) */
+ serviceDeskId: string;
+ };
+ };
+ requestBody: {
+ content: {
+ "multipart/form-data": components["schemas"]["MultipartFile"][];
+ };
+ };
+ responses: {
+ /** @description Returns if the file(s) were attached. */
+ 201: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the attachments are not valid, or exceed the maximum configured attachment size. */
+ 400: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the service desk does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if more than 60 files are requested to be uploaded. */
+ 413: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get customers
+ * @description This method returns a list of the customers on a service desk.
+ *
+ * The returned list of customers can be filtered using the `query` parameter. The parameter is matched against customers' `displayName`, `name`, or `email`. For example, searching for "John", "Jo", "Smi", or "Smith" will match a user with display name "John Smith".
+ *
+ * **[Permissions](#permissions) required**: Permission to view this Service Desk's customers.
+ */
+ getCustomers: {
+ parameters: {
+ query?: {
+ /** @description The string used to filter the customer list. */
+ query?: string;
+ /** @description The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details. */
+ start?: number;
+ /** @description The maximum number of users to return per page. Default: 50. See the [Pagination](#pagination) section for more details. */
+ limit?: number;
+ };
+ path: {
+ /** @description The ID of the service desk the customer list should be returned from. This can alternatively be a [project identifier.](#project-identifiers) */
+ serviceDeskId: string;
+ };
+ };
+ responses: {
+ /** @description Returns the service desk's customer list. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["PagedDTOUserDTO"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the service desk does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Add customers
+ * @description Adds one or more customers to a service desk. If any of the passed customers are associated with the service desk, no changes will be made for those customers and the resource returns a 204 success code.
+ *
+ * **[Permissions](#permissions) required**: Service desk administrator
+ */
+ addCustomers: {
+ parameters: {
+ path: {
+ /** @description The ID of the service desk the customer list should be returned from. This can alternatively be a [project identifier.](#project-identifiers) */
+ serviceDeskId: string;
+ };
+ };
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "accountIds": [
+ * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3a01db05e2a66fa80bd",
+ * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
+ * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d69abfa3980ce712caae"
+ * ],
+ * "usernames": [
+ * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3a01db05e2a66fa80bd",
+ * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
+ * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d69abfa3980ce712caae"
+ * ]
+ * }
+ */
+ "application/json": components["schemas"]["ServiceDeskCustomerDTO"];
+ };
+ };
+ responses: {
+ /** @description Returned if all the customers were added to the service desk or were already associated with the service desk. */
+ 204: {
+ content: never;
+ };
+ /** @description Returned if any of the customers do not exist. Note that any valid customers are added, but no confirmation is returned. */
+ 400: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the service desk does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Remove customers
+ * @description This method removes one or more customers from a service desk. The service desk must have closed access. If any of the passed customers are not associated with the service desk, no changes will be made for those customers and the resource returns a 204 success code.
+ *
+ * **[Permissions](#permissions) required**: Services desk administrator
+ */
+ removeCustomers: {
+ parameters: {
+ path: {
+ /** @description The ID of the service desk the customers should be removed from. This can alternatively be a [project identifier.](#project-identifiers) */
+ serviceDeskId: string;
+ };
+ };
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "accountIds": [
+ * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3a01db05e2a66fa80bd",
+ * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
+ * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d69abfa3980ce712caae"
+ * ],
+ * "usernames": [
+ * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3a01db05e2a66fa80bd",
+ * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b",
+ * "qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d69abfa3980ce712caae"
+ * ]
+ * }
+ */
+ "application/json": components["schemas"]["ServiceDeskCustomerDTO"];
+ };
+ };
+ responses: {
+ /** @description Returned if the customers were removed from the service desk, or any of the customers were not associated with the service desk. */
+ 204: {
+ content: never;
+ };
+ /** @description Returned if the service desk has public signup or open access enabled. */
+ 400: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the service desk does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Add organization
+ * @description This method adds an organization to a service desk. If the organization ID is already associated with the service desk, no change is made and the resource returns a 204 success code.
+ *
+ * **[Permissions](#permissions) required**: Service desk's agent.
+ */
+ addOrganization: {
+ parameters: {
+ path: {
+ /** @description The ID of the service desk to which the organization will be added. This can alternatively be a [project identifier.](#project-identifiers) */
+ serviceDeskId: string;
+ };
+ };
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "organizationId": 1
+ * }
+ */
+ "application/json": components["schemas"]["OrganizationServiceDeskUpdateDTO"];
+ };
+ };
+ responses: {
+ /** @description Returned if the organization was added or the organization was already associated with the service desk. */
+ 204: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the service desk or organization do not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Remove organization
+ * @description This method removes an organization from a service desk. If the organization ID does not match an organization associated with the service desk, no change is made and the resource returns a 204 success code.
+ *
+ * **[Permissions](#permissions) required**: Service desk's agent.
+ */
+ removeOrganization: {
+ parameters: {
+ path: {
+ /** @description The ID of the service desk from which the organization will be removed. This can alternatively be a [project identifier.](#project-identifiers) */
+ serviceDeskId: string;
+ };
+ };
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "organizationId": 1
+ * }
+ */
+ "application/json": components["schemas"]["OrganizationServiceDeskUpdateDTO"];
+ };
+ };
+ responses: {
+ /** @description Returned if the organization was removed from the service desk or no such organization was associated with the service desk. */
+ 204: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the service desk or organization do not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get queues
+ * @description This method returns the queues in a service desk. To include a customer request count for each queue (in the `issueCount` field) in the response, set the query parameter `includeCount` to true (its default is false).
+ *
+ * **[Permissions](#permissions) required**: service desk's Agent.
+ */
+ getQueues: {
+ parameters: {
+ query?: {
+ /** @description Specifies whether to include each queue's customer request (issue) count in the response. */
+ includeCount?: boolean;
+ /** @description The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details. */
+ start?: number;
+ /** @description The maximum number of items to return per page. Default: 50. See the [Pagination](#pagination) section for more details. */
+ limit?: number;
+ };
+ path: {
+ /** @description ID of the service desk whose queues will be returned. This can alternatively be a [project identifier.](#project-identifiers) */
+ serviceDeskId: string;
+ };
+ };
+ responses: {
+ /** @description Returns the queues of the service desk, on the specified page of the results. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["PagedDTOQueueDTO"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the service desk does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get queue
+ * @description This method returns a specific queues in a service desk. To include a customer request count for the queue (in the `issueCount` field) in the response, set the query parameter `includeCount` to true (its default is false).
+ *
+ * **[Permissions](#permissions) required**: service desk's Agent.
+ */
+ getQueue: {
+ parameters: {
+ query?: {
+ /** @description Specifies whether to include each queue's customer request (issue) count in the response. */
+ includeCount?: boolean;
+ };
+ path: {
+ /** @description ID of the service desk whose queues will be returned. This can alternatively be a [project identifier.](#project-identifiers) */
+ serviceDeskId: string;
+ /** @description ID of the required queue. */
+ queueId: number;
+ };
+ };
+ responses: {
+ /** @description Returns the specific queue of the service desk. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["QueueDTO"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the service desk does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get issues in queue
+ * @description This method returns the customer requests in a queue. Only fields that the queue is configured to show are returned. For example, if a queue is configured to show description and due date, then only those two fields are returned for each customer request in the queue.
+ *
+ * **[Permissions](#permissions) required**: Service desk's agent.
+ */
+ getIssuesInQueue: {
+ parameters: {
+ query?: {
+ /** @description The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details. */
+ start?: number;
+ /** @description The maximum number of items to return per page. Default: 50. See the [Pagination](#pagination) section for more details. */
+ limit?: number;
+ };
+ path: {
+ /** @description The ID of the service desk containing the queue to be queried. This can alternatively be a [project identifier.](#project-identifiers) */
+ serviceDeskId: string;
+ /** @description The ID of the queue whose customer requests will be returned. */
+ queueId: number;
+ };
+ };
+ responses: {
+ /** @description Returns the customer requests belonging to the queue, on the specified page of the results. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["PagedDTOIssueBean"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the service desk or the queue do not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get request types
+ * @description This method returns all customer request types from a service desk. There are two parameters for filtering the returned list:
+ *
+ * * `groupId` which filters the results to items in the customer request type group.
+ * * `searchQuery` which is matched against request types' `name` or `description`. For example, the strings "Install", "Inst", "Equi", or "Equipment" will match a request type with the *name* "Equipment Installation Request".
+ *
+ * **Note:** This API by default will filter out hidden request types (aka.request types without groups) when `searchQuery` is provided, unless `includeHiddenRequestTypesInSearch` is set to true.
+ *
+ * **[Permissions](#permissions) required**: Permission to access the service desk.
+ */
+ getRequestTypes: {
+ parameters: {
+ query?: {
+ /** @description Filters results to those in a customer request type group. */
+ groupId?: number;
+ expand?: string[];
+ /** @description The string to be used to filter the results. */
+ searchQuery?: string;
+ /** @description The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details. */
+ start?: number;
+ /** @description The maximum number of items to return per page. Default: 50. See the [Pagination](#pagination) section for more details. */
+ limit?: number;
+ /** @description Whether to include hidden request types when searching with `searchQuery`. Default: false */
+ includeHiddenRequestTypesInSearch?: boolean;
+ };
+ path: {
+ /** @description The ID of the service desk whose customer request types are to be returned. This can alternatively be a [project identifier.](#project-identifiers) */
+ serviceDeskId: string;
+ };
+ };
+ responses: {
+ /** @description Returns the requested customer request types, on the specified page of the results. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["PagedDTORequestTypeDTO"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the service desk does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Create request type
+ * @description This method enables a customer request type to be added to a service desk based on an issue type. Note that not all customer request type fields can be specified in the request and these fields are given the following default values:
+ *
+ * * Request type icon is given the headset icon.
+ * * Request type groups is left empty, which means this customer request type will not be visible on the [customer portal](https://confluence.atlassian.com/servicedeskcloud/configuring-the-customer-portal-732528918.html).
+ * * Request type status mapping is left empty, so the request type has no custom status mapping but inherits the status map from the issue type upon which it is based.
+ * * Request type field mapping is set to show the required fields as specified by the issue type used to create the customer request type.
+ *
+ *
+ * These fields can be updated by a service desk administrator using the **Request types** option in **Project settings**.
+ * Request Types are created in next-gen projects by creating Issue Types. Please use the Jira Cloud Platform Create issue type endpoint instead.
+ *
+ * **[Permissions](#permissions) required**: Service desk's administrator
+ */
+ createRequestType: {
+ parameters: {
+ path: {
+ /** @description The ID of the service desk where the customer request type is to be created. This can alternatively be a [project identifier.](#project-identifiers) */
+ serviceDeskId: string;
+ };
+ };
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "description": "Get IT Help",
+ * "helpText": "Please tell us clearly the problem you have within 100 words.",
+ * "issueTypeId": "12345",
+ * "name": "Get IT Help"
+ * }
+ */
+ "application/json": components["schemas"]["RequestTypeCreateDTO"];
+ };
+ };
+ responses: {
+ /** @description Returns the customer request type created. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["RequestTypeDTO"];
+ };
+ };
+ /** @description Returned if the customer request type name is empty. */
+ 400: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the service desk or issue type do not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get request type by id
+ * @description This method returns a customer request type from a service desk.
+ *
+ * This operation can be accessed anonymously.
+ *
+ * **[Permissions](#permissions) required**: Permission to access the service desk.
+ */
+ getRequestTypeById: {
+ parameters: {
+ query?: {
+ expand?: string[];
+ };
+ path: {
+ /** @description The ID of the service desk whose customer request type is to be returned. This can alternatively be a [project identifier.](#project-identifiers) */
+ serviceDeskId: string;
+ /** @description The ID of the customer request type to be returned. */
+ requestTypeId: string;
+ };
+ };
+ responses: {
+ /** @description Returns the customer request type item. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["RequestTypeDTO"];
+ };
+ };
+ /** @description Returned if the user credentials are invalid. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the service desk or customer request type do not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Delete request type
+ * @description This method deletes a customer request type from a service desk, and removes it from all customer requests.
+ * This only supports classic projects.
+ *
+ * **[Permissions](#permissions) required**: Service desk administrator.
+ */
+ deleteRequestType: {
+ parameters: {
+ path: {
+ /** @description The ID or [project identifier](#project-identifiers) of the service desk. */
+ serviceDeskId: string;
+ /** @description The ID of the request type. */
+ requestTypeId: number;
+ };
+ };
+ responses: {
+ /** @description Returned if the request type is deleted. */
+ 204: {
+ content: never;
+ };
+ /** @description Returned if the request type ID is not valid. */
+ 400: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have the necessary permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the service desk or request type do not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get request type fields
+ * @description This method returns the fields for a service desk's customer request type.
+ *
+ * Also, the following information about the user's permissions for the request type is returned:
+ *
+ * * `canRaiseOnBehalfOf` returns `true` if the user has permission to raise customer requests on behalf of other customers. Otherwise, returns `false`.
+ * * `canAddRequestParticipants` returns `true` if the user can add customer request participants. Otherwise, returns `false`.
+ *
+ * **[Permissions](#permissions) required**: Permission to view the Service Desk. However, hidden fields would be visible to only Service desk's Administrator.
+ */
+ getRequestTypeFields: {
+ parameters: {
+ query?: {
+ /** @description Use [expand](#expansion) to include additional information in the response. This parameter accepts `hiddenFields` that returns hidden fields associated with the request type. */
+ expand?: string[];
+ };
+ path: {
+ /** @description The ID of the service desk containing the request types whose fields are to be returned. This can alternatively be a [project identifier.](#project-identifiers) */
+ serviceDeskId: string;
+ /** @description The ID of the request types whose fields are to be returned. */
+ requestTypeId: number;
+ };
+ };
+ responses: {
+ /** @description Returns the request type's fields and user permission details, on the specified page of the results. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["CustomerRequestCreateMetaDTO"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the service desk or request type do not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+ /**
+ * Get request type groups
+ * @description This method returns a service desk's customer request type groups. Jira Service Management administrators can arrange the customer request type groups in an arbitrary order for display on the customer portal; the groups are returned in this order.
+ *
+ * **[Permissions](#permissions) required**: Permission to view the service desk.
+ */
+ getRequestTypeGroups: {
+ parameters: {
+ query?: {
+ /** @description The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details. */
+ start?: number;
+ /** @description The maximum number of items to return per page. Default: 50. See the [Pagination](#pagination) section for more details. */
+ limit?: number;
+ };
+ path: {
+ /** @description The ID of the service desk whose customer request type groups are to be returned. This can alternatively be a [project identifier.](#project-identifiers) */
+ serviceDeskId: string;
+ };
+ };
+ responses: {
+ /** @description Returns the service desk's customer request type groups, on the specified page of the results. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["PagedDTORequestTypeGroupDTO"];
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the user does not have permission to complete this request. */
+ 403: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Returned if the service desk does not exist. */
+ 404: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ /** @description Internal Server Error. */
+ 500: {
+ content: {
+ "application/json": components["schemas"]["ErrorResponse"];
+ };
+ };
+ };
+ };
+}
diff --git a/src/generated/openapi-software.ts b/src/generated/openapi-software.ts
new file mode 100644
index 0000000..724244e
--- /dev/null
+++ b/src/generated/openapi-software.ts
@@ -0,0 +1,11646 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+/** OneOf type helpers */
+type Without = { [P in Exclude]?: never };
+type XOR = T | U extends object ? (Without & U) | (Without & T) : T | U;
+type OneOf = T extends [infer Only]
+ ? Only
+ : T extends [infer A, infer B, ...infer Rest]
+ ? OneOf<[XOR, ...Rest]>
+ : never;
+
+export interface paths {
+ "/rest/agile/1.0/backlog/issue": {
+ /**
+ * Move issues to backlog
+ * @description Move issues to the backlog.
+ * This operation is equivalent to remove future and active sprints from a given set of issues. At most 50 issues may be moved at once.
+ */
+ post: operations["moveIssuesToBacklog"];
+ };
+ "/rest/agile/1.0/backlog/{boardId}/issue": {
+ /**
+ * Move issues to backlog for board
+ * @description Move issues to the backlog of a particular board (if they are already on that board).
+ * This operation is equivalent to remove future and active sprints from a given set of issues if the board has sprints If the board does not have sprints this will put the issues back into the backlog from the board. At most 50 issues may be moved at once.
+ */
+ post: operations["moveIssuesToBacklogForBoard"];
+ };
+ "/rest/agile/1.0/board": {
+ /**
+ * Get all boards
+ * @description Returns all boards. This only includes boards that the user has permission to view.
+ *
+ * **Deprecation notice:** The required OAuth 2.0 scopes will be updated on February 15, 2024.
+ *
+ * * `read:board-scope:jira-software`, `read:project:jira`
+ */
+ get: operations["getAllBoards"];
+ /**
+ * Create board
+ * @description Creates a new board. Board name, type and filter ID is required.
+ *
+ * * `name` \- Must be less than 255 characters.
+ * * `type` \- Valid values: scrum, kanban
+ * * `filterId` \- ID of a filter that the user has permissions to view. Note, if the user does not have the 'Create shared objects' permission and tries to create a shared board, a private board will be created instead (remember that board sharing depends on the filter sharing).
+ * * `location` \- The container that the board will be located in. `location` must include the `type` property (Valid values: project, user). If choosing 'project', then a project must be specified by a `projectKeyOrId` property in `location`. If choosing 'user', the current user is chosen by default. The `projectKeyOrId` property should not be provided.
+ *
+ * Note:
+ *
+ * * If you want to create a new project with an associated board, use the [Jira platform REST API](https://docs.atlassian.com/jira/REST/latest). For more information, see the [Create project](#api-rest-api-3-project-post) method. The `projectTypeKey` for software boards must be 'software' and the `projectTemplateKey` must be either `com.pyxis.greenhopper.jira:gh-kanban-template` or `com.pyxis.greenhopper.jira:gh-scrum-template`.
+ * * You can create a filter using the [Jira REST API](https://docs.atlassian.com/jira/REST/latest). For more information, see the [Create filter](#api-rest-api-3-filter-post) method.
+ * * If you do not ORDER BY the Rank field for the filter of your board, you will not be able to reorder issues on the board.
+ */
+ post: operations["createBoard"];
+ };
+ "/rest/agile/1.0/board/filter/{filterId}": {
+ /**
+ * Get board by filter id
+ * @description Returns any boards which use the provided filter id. This method can be executed by users without a valid software license in order to find which boards are using a particular filter.
+ */
+ get: operations["getBoardByFilterId"];
+ };
+ "/rest/agile/1.0/board/{boardId}": {
+ /**
+ * Get board
+ * @description Returns the board for the given board ID. This board will only be returned if the user has permission to view it. Admins without the view permission will see the board as a private one, so will see only a subset of the board's data (board location for instance).
+ */
+ get: operations["getBoard"];
+ /**
+ * Delete board
+ * @description Deletes the board. Admin without the view permission can still remove the board.
+ */
+ delete: operations["deleteBoard"];
+ };
+ "/rest/agile/1.0/board/{boardId}/backlog": {
+ /**
+ * Get issues for backlog
+ * @description Returns all issues from the board's backlog, for the given board ID. This only includes issues that the user has permission to view. The backlog contains incomplete issues that are not assigned to any future or active sprint. Note, if the user does not have permission to view the board, no issues will be returned at all. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank.
+ */
+ get: operations["getIssuesForBacklog"];
+ };
+ "/rest/agile/1.0/board/{boardId}/configuration": {
+ /**
+ * Get configuration
+ * @description Get the board configuration. The response contains the following fields:
+ *
+ * * `id` \- ID of the board.
+ * * `name` \- Name of the board.
+ * * `filter` \- Reference to the filter used by the given board.
+ * * `location` \- Reference to the container that the board is located in. Includes the container type (Valid values: project, user).
+ * * `subQuery` (Kanban only) - JQL subquery used by the given board.
+ * * `columnConfig` \- The column configuration lists the columns for the board, in the order defined in the column configuration. For each column, it shows the issue status mapping as well as the constraint type (Valid values: none, issueCount, issueCountExclSubs) for the min/max number of issues. Note, the last column with statuses mapped to it is treated as the "Done" column, which means that issues in that column will be marked as already completed.
+ * * `estimation` (Scrum only) - Contains information about type of estimation used for the board. Valid values: none, issueCount, field. If the estimation type is "field", the ID and display name of the field used for estimation is also returned. Note, estimates for an issue can be updated by a PUT /rest/api/3/issue/\{issueIdOrKey\} request, however the fields must be on the screen. "timeoriginalestimate" field will never be on the screen, so in order to update it "originalEstimate" in "timetracking" field should be updated.
+ * * `ranking` \- Contains information about custom field used for ranking in the given board.
+ */
+ get: operations["getConfiguration"];
+ };
+ "/rest/agile/1.0/board/{boardId}/epic": {
+ /**
+ * Get epics
+ * @description Returns all epics from the board, for the given board ID. This only includes epics that the user has permission to view. Note, if the user does not have permission to view the board, no epics will be returned at all.
+ */
+ get: operations["getEpics"];
+ };
+ "/rest/agile/1.0/board/{boardId}/epic/none/issue": {
+ /**
+ * Get issues without epic for board
+ * @description Returns all issues that do not belong to any epic on a board, for a given board ID. This only includes issues that the user has permission to view. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank.
+ */
+ get: operations["getIssuesWithoutEpicForBoard"];
+ };
+ "/rest/agile/1.0/board/{boardId}/epic/{epicId}/issue": {
+ /**
+ * Get board issues for epic
+ * @description Returns all issues that belong to an epic on the board, for the given epic ID and the board ID. This only includes issues that the user has permission to view. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank.
+ */
+ get: operations["getBoardIssuesForEpic"];
+ };
+ "/rest/agile/1.0/board/{boardId}/features": {
+ /** Get features for board */
+ get: operations["getFeaturesForBoard"];
+ /** Toggle features */
+ put: operations["toggleFeatures"];
+ };
+ "/rest/agile/1.0/board/{boardId}/issue": {
+ /**
+ * Get issues for board
+ * @description Returns all issues from a board, for a given board ID. This only includes issues that the user has permission to view. An issue belongs to the board if its status is mapped to the board's column. Epic issues do not belongs to the scrum boards. Note, if the user does not have permission to view the board, no issues will be returned at all. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank.
+ */
+ get: operations["getIssuesForBoard"];
+ /**
+ * Move issues to board
+ * @description Move issues from the backog to the board (if they are already in the backlog of that board).
+ * This operation either moves an issue(s) onto a board from the backlog (by adding it to the issueList for the board) Or transitions the issue(s) to the first column for a kanban board with backlog. At most 50 issues may be moved at once.
+ */
+ post: operations["moveIssuesToBoard"];
+ };
+ "/rest/agile/1.0/board/{boardId}/project": {
+ /**
+ * Get projects
+ * @description Returns all projects that are associated with the board, for the given board ID. If the user does not have permission to view the board, no projects will be returned at all. Returned projects are ordered by the name.
+ *
+ * A project is associated with a board if the board filter contains reference the project or there is an issue from the project that belongs to the board.
+ *
+ * The board filter contains reference the project only if JQL query guarantees that returned issues will be returned from the project set defined in JQL. For instance the query `project in (ABC, BCD) AND reporter = admin` have reference to ABC and BCD projects but query `project in (ABC, BCD) OR reporter = admin` doesn't have reference to any project.
+ *
+ * An issue belongs to the board if its status is mapped to the board's column. Epic issues do not belongs to the scrum boards.
+ */
+ get: operations["getProjects"];
+ };
+ "/rest/agile/1.0/board/{boardId}/project/full": {
+ /**
+ * Get projects full
+ * @description Returns all projects that are statically associated with the board, for the given board ID. Returned projects are ordered by the name.
+ *
+ * A project is associated with a board if the board filter contains reference the project.
+ *
+ * The board filter contains reference the project only if JQL query guarantees that returned issues will be returned from the project set defined in JQL. For instance the query `project in (ABC, BCD) AND reporter = admin` have reference to ABC and BCD projects but query `project in (ABC, BCD) OR reporter = admin` doesn't have reference to any project.
+ */
+ get: operations["getProjectsFull"];
+ };
+ "/rest/agile/1.0/board/{boardId}/properties": {
+ /**
+ * Get board property keys
+ * @description Returns the keys of all properties for the board identified by the id. The user who retrieves the property keys is required to have permissions to view the board.
+ */
+ get: operations["getBoardPropertyKeys"];
+ };
+ "/rest/agile/1.0/board/{boardId}/properties/{propertyKey}": {
+ /**
+ * Get board property
+ * @description Returns the value of the property with a given key from the board identified by the provided id. The user who retrieves the property is required to have permissions to view the board.
+ */
+ get: operations["getBoardProperty"];
+ /**
+ * Set board property
+ * @description Sets the value of the specified board's property.
+ *
+ * You can use this resource to store a custom data against the board identified by the id. The user who stores the data is required to have permissions to modify the board.
+ */
+ put: operations["setBoardProperty"];
+ /**
+ * Delete board property
+ * @description Removes the property from the board identified by the id. Ths user removing the property is required to have permissions to modify the board.
+ */
+ delete: operations["deleteBoardProperty"];
+ };
+ "/rest/agile/1.0/board/{boardId}/quickfilter": {
+ /**
+ * Get all quick filters
+ * @description Returns all quick filters from a board, for a given board ID.
+ */
+ get: operations["getAllQuickFilters"];
+ };
+ "/rest/agile/1.0/board/{boardId}/quickfilter/{quickFilterId}": {
+ /**
+ * Get quick filter
+ * @description Returns the quick filter for a given quick filter ID. The quick filter will only be returned if the user can view the board that the quick filter belongs to.
+ */
+ get: operations["getQuickFilter"];
+ };
+ "/rest/agile/1.0/board/{boardId}/reports": {
+ /** Get reports for board */
+ get: operations["getReportsForBoard"];
+ };
+ "/rest/agile/1.0/board/{boardId}/sprint": {
+ /**
+ * Get all sprints
+ * @description Returns all sprints from a board, for a given board ID. This only includes sprints that the user has permission to view.
+ */
+ get: operations["getAllSprints"];
+ };
+ "/rest/agile/1.0/board/{boardId}/sprint/{sprintId}/issue": {
+ /**
+ * Get board issues for sprint
+ * @description Get all issues you have access to that belong to the sprint from the board. Issue returned from this resource contains additional fields like: sprint, closedSprints, flagged and epic. Issues are returned ordered by rank. JQL order has higher priority than default rank.
+ */
+ get: operations["getBoardIssuesForSprint"];
+ };
+ "/rest/agile/1.0/board/{boardId}/version": {
+ /**
+ * Get all versions
+ * @description Returns all versions from a board, for a given board ID. This only includes versions that the user has permission to view. Note, if the user does not have permission to view the board, no versions will be returned at all. Returned versions are ordered by the name of the project from which they belong and then by sequence defined by user.
+ */
+ get: operations["getAllVersions"];
+ };
+ "/rest/agile/1.0/epic/none/issue": {
+ /**
+ * Get issues without epic
+ * @description Returns all issues that do not belong to any epic. This only includes issues that the user has permission to view. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank. **Note:** If you are querying a next-gen project, do not use this operation. Instead, search for issues that don't belong to an epic by using the [Search for issues using JQL](https://developer.atlassian.com/cloud/jira/platform/rest/v2/#api-rest-api-2-search-get) operation in the Jira platform REST API. Build your JQL query using the `parent is empty` clause. For more information on the `parent` JQL field, see [Advanced searching](https://confluence.atlassian.com/x/dAiiLQ#Advancedsearching-fieldsreference-Parent).
+ */
+ get: operations["getIssuesWithoutEpic"];
+ /**
+ * Remove issues from epic
+ * @description Removes issues from epics. The user needs to have the edit issue permission for all issue they want to remove from epics. The maximum number of issues that can be moved in one operation is 50. **Note:** This operation does not work for epics in next-gen projects. Instead, update the issue using `\{ fields: \{ parent: \{\} \} \}`
+ */
+ post: operations["removeIssuesFromEpic"];
+ };
+ "/rest/agile/1.0/epic/{epicIdOrKey}": {
+ /**
+ * Get epic
+ * @description Returns the epic for a given epic ID. This epic will only be returned if the user has permission to view it. **Note:** This operation does not work for epics in next-gen projects.
+ */
+ get: operations["getEpic"];
+ /**
+ * Partially update epic
+ * @description Performs a partial update of the epic. A partial update means that fields not present in the request JSON will not be updated. Valid values for color are `color_1` to `color_9`. **Note:** This operation does not work for epics in next-gen projects.
+ */
+ post: operations["partiallyUpdateEpic"];
+ };
+ "/rest/agile/1.0/epic/{epicIdOrKey}/issue": {
+ /**
+ * Get issues for epic
+ * @description Returns all issues that belong to the epic, for the given epic ID. This only includes issues that the user has permission to view. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank. **Note:** If you are querying a next-gen project, do not use this operation. Instead, search for issues that belong to an epic by using the [Search for issues using JQL](https://developer.atlassian.com/cloud/jira/platform/rest/v2/#api-rest-api-2-search-get) operation in the Jira platform REST API. Build your JQL query using the `parent` clause. For more information on the `parent` JQL field, see [Advanced searching](https://confluence.atlassian.com/x/dAiiLQ#Advancedsearching-fieldsreference-Parent).
+ */
+ get: operations["getIssuesForEpic"];
+ /**
+ * Move issues to epic
+ * @description Moves issues to an epic, for a given epic id. Issues can be only in a single epic at the same time. That means that already assigned issues to an epic, will not be assigned to the previous epic anymore. The user needs to have the edit issue permission for all issue they want to move and to the epic. The maximum number of issues that can be moved in one operation is 50. **Note:** This operation does not work for epics in next-gen projects.
+ */
+ post: operations["moveIssuesToEpic"];
+ };
+ "/rest/agile/1.0/epic/{epicIdOrKey}/rank": {
+ /**
+ * Rank epics
+ * @description Moves (ranks) an epic before or after a given epic.
+ *
+ * If rankCustomFieldId is not defined, the default rank field will be used.
+ *
+ * **Note:** This operation does not work for epics in next-gen projects.
+ */
+ put: operations["rankEpics"];
+ };
+ "/rest/agile/1.0/issue/rank": {
+ /**
+ * Rank issues
+ * @description Moves (ranks) issues before or after a given issue. At most 50 issues may be ranked at once.
+ *
+ * This operation may fail for some issues, although this will be rare. In that case the 207 status code is returned for the whole response and detailed information regarding each issue is available in the response body.
+ *
+ * If rankCustomFieldId is not defined, the default rank field will be used.
+ */
+ put: operations["rankIssues"];
+ };
+ "/rest/agile/1.0/issue/{issueIdOrKey}": {
+ /**
+ * Get issue
+ * @description Returns a single issue, for a given issue ID or issue key. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic.
+ */
+ get: operations["getIssue"];
+ };
+ "/rest/agile/1.0/issue/{issueIdOrKey}/estimation": {
+ /**
+ * Get issue estimation for board
+ * @description Returns the estimation of the issue and a fieldId of the field that is used for it. `boardId` param is required. This param determines which field will be updated on a issue.
+ *
+ * Original time internally stores and returns the estimation as a number of seconds.
+ *
+ * The field used for estimation on the given board can be obtained from [board configuration resource](#agile/1.0/board-getConfiguration). More information about the field are returned by [edit meta resource](#api-rest-api-3-issue-getEditIssueMeta) or [field resource](#api-rest-api-3-field-get).
+ */
+ get: operations["getIssueEstimationForBoard"];
+ /**
+ * Estimate issue for board
+ * @description Updates the estimation of the issue. boardId param is required. This param determines which field will be updated on a issue.
+ *
+ * Note that this resource changes the estimation field of the issue regardless of appearance the field on the screen.
+ *
+ * Original time tracking estimation field accepts estimation in formats like "1w", "2d", "3h", "20m" or number which represent number of minutes. However, internally the field stores and returns the estimation as a number of seconds.
+ *
+ * The field used for estimation on the given board can be obtained from [board configuration resource](#agile/1.0/board-getConfiguration). More information about the field are returned by [edit meta resource](#api-rest-api-3-issue-issueIdOrKey-editmeta-get) or [field resource](#api-rest-api-3-field-get).
+ */
+ put: operations["estimateIssueForBoard"];
+ };
+ "/rest/agile/1.0/sprint": {
+ /**
+ * Create sprint
+ * @description Creates a future sprint. Sprint name and origin board id are required. Start date, end date, and goal are optional.
+ *
+ * Note that the sprint name is trimmed. Also, when starting sprints from the UI, the "endDate" set through this call is ignored and instead the last sprint's duration is used to fill the form.
+ */
+ post: operations["createSprint"];
+ };
+ "/rest/agile/1.0/sprint/{sprintId}": {
+ /**
+ * Get sprint
+ * @description Returns the sprint for a given sprint ID. The sprint will only be returned if the user can view the board that the sprint was created on, or view at least one of the issues in the sprint.
+ */
+ get: operations["getSprint"];
+ /**
+ * Update sprint
+ * @description Performs a full update of a sprint. A full update means that the result will be exactly the same as the request body. Any fields not present in the request JSON will be set to null.
+ *
+ * Notes:
+ *
+ * * Sprints that are in a closed state cannot be updated.
+ * * A sprint can be started by updating the state to 'active'. This requires the sprint to be in the 'future' state and have a startDate and endDate set.
+ * * A sprint can be completed by updating the state to 'closed'. This action requires the sprint to be in the 'active' state. This sets the completeDate to the time of the request.
+ * * Other changes to state are not allowed.
+ * * The completeDate field cannot be updated manually.
+ */
+ put: operations["updateSprint"];
+ /**
+ * Partially update sprint
+ * @description Performs a partial update of a sprint. A partial update means that fields not present in the request JSON will not be updated.
+ *
+ * Notes:
+ *
+ * * Sprints that are in a closed state cannot be updated.
+ * * A sprint can be started by updating the state to 'active'. This requires the sprint to be in the 'future' state and have a startDate and endDate set.
+ * * A sprint can be completed by updating the state to 'closed'. This action requires the sprint to be in the 'active' state. This sets the completeDate to the time of the request.
+ * * Other changes to state are not allowed.
+ * * The completeDate field cannot be updated manually.
+ */
+ post: operations["partiallyUpdateSprint"];
+ /**
+ * Delete sprint
+ * @description Deletes a sprint. Once a sprint is deleted, all open issues in the sprint will be moved to the backlog.
+ */
+ delete: operations["deleteSprint"];
+ };
+ "/rest/agile/1.0/sprint/{sprintId}/issue": {
+ /**
+ * Get issues for sprint
+ * @description Returns all issues in a sprint, for a given sprint ID. This only includes issues that the user has permission to view. By default, the returned issues are ordered by rank.
+ */
+ get: operations["getIssuesForSprint"];
+ /**
+ * Move issues to sprint and rank
+ * @description Moves issues to a sprint, for a given sprint ID. Issues can only be moved to open or active sprints. The maximum number of issues that can be moved in one operation is 50.
+ */
+ post: operations["moveIssuesToSprintAndRank"];
+ };
+ "/rest/agile/1.0/sprint/{sprintId}/properties": {
+ /**
+ * Get properties keys
+ * @description Returns the keys of all properties for the sprint identified by the id. The user who retrieves the property keys is required to have permissions to view the sprint.
+ */
+ get: operations["getPropertiesKeys"];
+ };
+ "/rest/agile/1.0/sprint/{sprintId}/properties/{propertyKey}": {
+ /**
+ * Get property
+ * @description Returns the value of the property with a given key from the sprint identified by the provided id. The user who retrieves the property is required to have permissions to view the sprint.
+ */
+ get: operations["getProperty"];
+ /**
+ * Set property
+ * @description Sets the value of the specified sprint's property.
+ *
+ * You can use this resource to store a custom data against the sprint identified by the id. The user who stores the data is required to have permissions to modify the sprint.
+ */
+ put: operations["setProperty"];
+ /**
+ * Delete property
+ * @description Removes the property from the sprint identified by the id. Ths user removing the property is required to have permissions to modify the sprint.
+ */
+ delete: operations["deleteProperty"];
+ };
+ "/rest/agile/1.0/sprint/{sprintId}/swap": {
+ /**
+ * Swap sprint
+ * @description Swap the position of the sprint with the second sprint.
+ */
+ post: operations["swapSprint"];
+ };
+ "/rest/devinfo/0.10/bulk": {
+ /**
+ * Store development information
+ * @description Stores development information provided in the request to make it available when viewing issues in Jira. Existing repository and entity data for the same ID will be replaced if the updateSequenceId of existing data is less than the incoming data. Submissions are performed asynchronously. Submitted data will eventually be available in Jira; most updates are available within a short period of time, but may take some time during peak load and/or maintenance times.
+ */
+ post: operations["storeDevelopmentInformation"];
+ };
+ "/rest/devinfo/0.10/repository/{repositoryId}": {
+ /**
+ * Get repository
+ * @description For the specified repository ID, retrieves the repository and the most recent 400 development information entities. The result will be what is currently stored, ignoring any pending updates or deletes.
+ */
+ get: operations["getRepository"];
+ /**
+ * Delete repository
+ * @description Deletes the repository data stored by the given ID and all related development information entities. Deletion is performed asynchronously.
+ */
+ delete: operations["deleteRepository"];
+ };
+ "/rest/devinfo/0.10/bulkByProperties": {
+ /**
+ * Delete development information by properties
+ * @description Deletes development information entities which have all the provided properties. Entities will be deleted that match ALL of the properties (i.e. treated as an AND). For example if request is `DELETE bulk?accountId=123&projectId=ABC` entities which have properties `accountId=123` and `projectId=ABC` will be deleted. Special property `_updateSequenceId` can be used to delete all entities with updateSequenceId less or equal than the value specified. In addition to the optional `_updateSequenceId`, one or more query params must be supplied to specify properties to delete by. Deletion is performed asynchronously: specified entities will eventually be removed from Jira.
+ */
+ delete: operations["deleteByProperties"];
+ };
+ "/rest/devinfo/0.10/existsByProperties": {
+ /**
+ * Check if data exists for the supplied properties
+ * @description Checks if development information which have all the provided properties exists. For example, if request is `GET existsByProperties?accountId=123&projectId=ABC` then result will be positive only if there is at least one entity or repository with both properties `accountId=123` and `projectId=ABC`. Special property `_updateSequenceId` can be used to filter all entities with updateSequenceId less or equal than the value specified. In addition to the optional `_updateSequenceId`, one or more query params must be supplied to specify properties to search by.
+ */
+ get: operations["existsByProperties"];
+ };
+ "/rest/devinfo/0.10/repository/{repositoryId}/{entityType}/{entityId}": {
+ /**
+ * Delete development information entity
+ * @description Deletes particular development information entity. Deletion is performed asynchronously.
+ */
+ delete: operations["deleteEntity"];
+ };
+ "/rest/featureflags/0.1/bulk": {
+ /**
+ * Submit Feature Flag data
+ * @description Update / insert Feature Flag data.
+ *
+ * Feature Flags are identified by their ID, and existing Feature Flag data for the same ID will be replaced if it exists and the updateSequenceId of existing data is less than the incoming data.
+ *
+ * Submissions are performed asynchronously. Submitted data will eventually be available in Jira; most updates are available within a short period of time, but may take some time during peak load and/or maintenance times. The getFeatureFlagById operation can be used to confirm that data has been stored successfully (if needed).
+ *
+ * In the case of multiple Feature Flags being submitted in one request, each is validated individually prior to submission. Details of which Feature Flags failed submission (if any) are available in the response object.
+ *
+ * Only Connect apps that define the `jiraFeatureFlagInfoProvider` module can access this resource.
+ * This resource requires the 'WRITE' scope for Connect apps.
+ */
+ post: operations["submitFeatureFlags"];
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with a Connect JWT token that corresponds to the Provider app installed in Jira.
+ *
+ * If the JWT token corresponds to an app that does not define Feature Flags module it will be rejected with a 403.
+ *
+ * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details.
+ */
+ Authorization: string;
+ };
+ };
+ };
+ "/rest/featureflags/0.1/bulkByProperties": {
+ /**
+ * Delete Feature Flags by Property
+ * @description Bulk delete all Feature Flags that match the given request.
+ *
+ * One or more query params must be supplied to specify Properties to delete by. Optional param `_updateSequenceId` is no longer supported.
+ * If more than one Property is provided, data will be deleted that matches ALL of the Properties (e.g. treated as an AND).
+ * See the documentation for the submitFeatureFlags operation for more details.
+ *
+ * e.g. DELETE /bulkByProperties?accountId=account-123&createdBy=user-456
+ *
+ * Deletion is performed asynchronously. The getFeatureFlagById operation can be used to confirm that data has been deleted successfully (if needed).
+ *
+ * Only Connect apps that define the `jiraFeatureFlagInfoProvider` module can access this resource.
+ * This resource requires the 'DELETE' scope for Connect apps.
+ */
+ delete: operations["deleteFeatureFlagsByProperty"];
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with a Connect JWT token that corresponds to the Provider app installed in Jira.
+ *
+ * If the JWT token corresponds to an app that does not define Feature Flags module it will be rejected with a 403.
+ *
+ * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details.
+ */
+ Authorization: string;
+ };
+ };
+ };
+ "/rest/featureflags/0.1/flag/{featureFlagId}": {
+ /**
+ * Get a Feature Flag by ID
+ * @description Retrieve the currently stored Feature Flag data for the given ID.
+ *
+ * The result will be what is currently stored, ignoring any pending updates or deletes.
+ *
+ * Only Connect apps that define the `jiraFeatureFlagInfoProvider` module can access this resource.
+ * This resource requires the 'READ' scope for Connect apps.
+ */
+ get: operations["getFeatureFlagById"];
+ /**
+ * Delete a Feature Flag by ID
+ * @description Delete the Feature Flag data currently stored for the given ID.
+ *
+ * Deletion is performed asynchronously. The getFeatureFlagById operation can be used to confirm that data has been deleted successfully (if needed).
+ *
+ * Only Connect apps that define the `jiraFeatureFlagInfoProvider` module can access this resource.
+ * This resource requires the 'DELETE' scope for Connect apps.
+ */
+ delete: operations["deleteFeatureFlagById"];
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with a Connect JWT token that corresponds to the Provider app installed in Jira.
+ *
+ * If the JWT token corresponds to an app that does not define Feature Flags module it will be rejected with a 403.
+ *
+ * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details.
+ */
+ Authorization: string;
+ };
+ };
+ };
+ "/rest/deployments/0.1/bulk": {
+ /**
+ * Submit deployment data
+ * @description Update / insert deployment data.
+ *
+ * Deployments are identified by the combination of `pipelineId`, `environmentId` and `deploymentSequenceNumber`, and existing deployment data for the same deployment will be replaced if it exists and the `updateSequenceNumber` of existing data is less than the incoming data.
+ *
+ * Submissions are processed asynchronously. Submitted data will eventually be available in Jira. Most updates are available within a short period of time, but may take some time during peak load and/or maintenance times. The `getDeploymentByKey` operation can be used to confirm that data has been stored successfully (if needed).
+ *
+ * In the case of multiple deployments being submitted in one request, each is validated individually prior to submission. Details of which deployments failed submission (if any) are available in the response object.
+ *
+ * Only Connect apps that define the `jiraDeploymentInfoProvider` module, and on-premise integrations, can access this resource.
+ * This resource requires the 'WRITE' scope for Connect apps.
+ */
+ post: operations["submitDeployments"];
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that corresponds to an app installed in Jira.
+ *
+ * If the Connect JWT token corresponds to an app that does not define `jiraDeploymentInfoProvider` module it will be rejected with a 403.
+ *
+ * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens.
+ * See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations.
+ */
+ Authorization: string;
+ };
+ };
+ };
+ "/rest/deployments/0.1/bulkByProperties": {
+ /**
+ * Delete deployments by Property
+ * @description Bulk delete all deployments that match the given request.
+ *
+ * One or more query params must be supplied to specify the Properties to delete by. Optional param `_updateSequenceNumber` is no longer supported.
+ * If more than one Property is provided, data will be deleted that matches ALL of the Properties (i.e. treated as AND).
+ * See the documentation for the `submitDeployments` operation for more details.
+ *
+ * Example operation: DELETE /bulkByProperties?accountId=account-123&createdBy=user-456
+ *
+ * Deletion is performed asynchronously. The `getDeploymentByKey` operation can be used to confirm that data has been deleted successfully (if needed).
+ *
+ * Only Connect apps that define the `jiraDeploymentInfoProvider` module, and on-premise integrations, can access this resource.
+ * This resource requires the 'DELETE' scope for Connect apps.
+ */
+ delete: operations["deleteDeploymentsByProperty"];
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that corresponds to an app installed in Jira.
+ *
+ * If the Connect JWT token corresponds to an app that does not define `jiraDeploymentInfoProvider` module it will be rejected with a 403.
+ *
+ * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens.
+ * See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations.
+ */
+ Authorization: string;
+ };
+ };
+ };
+ "/rest/deployments/0.1/pipelines/{pipelineId}/environments/{environmentId}/deployments/{deploymentSequenceNumber}": {
+ /**
+ * Get a deployment by key
+ * @description Retrieve the currently stored deployment data for the given `pipelineId`, `environmentId` and `deploymentSequenceNumber` combination.
+ *
+ * The result will be what is currently stored, ignoring any pending updates or deletes.
+ *
+ * Only Connect apps that define the `jiraDeploymentInfoProvider` module, and on-premise integrations, can access this resource.
+ * This resource requires the 'READ' scope for Connect apps.
+ */
+ get: operations["getDeploymentByKey"];
+ /**
+ * Delete a deployment by key
+ * @description Delete the currently stored deployment data for the given `pipelineId`, `environmentId` and `deploymentSequenceNumber` combination.
+ *
+ * Deletion is performed asynchronously. The `getDeploymentByKey` operation can be used to confirm that data has been deleted successfully (if needed).
+ *
+ * Only Connect apps that define the `jiraDeploymentInfoProvider` module, and on-premise integrations, can access this resource.
+ * This resource requires the 'DELETE' scope for Connect apps.
+ */
+ delete: operations["deleteDeploymentByKey"];
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that corresponds to an app installed in Jira.
+ *
+ * If the Connect JWT token corresponds to an app that does not define `jiraDeploymentInfoProvider` module it will be rejected with a 403.
+ *
+ * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens.
+ * See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations.
+ */
+ Authorization: string;
+ };
+ };
+ };
+ "/rest/deployments/0.1/pipelines/{pipelineId}/environments/{environmentId}/deployments/{deploymentSequenceNumber}/gating-status": {
+ /**
+ * Get deployment gating status by key
+ * @description Retrieve the Deployment gating status for the given `pipelineId + environmentId + deploymentSequenceNumber` combination.
+ * Only apps that define the `jiraDeploymentInfoProvider` module can access this resource. This resource requires the 'READ' scope.
+ */
+ get: operations["getDeploymentGatingStatusByKey"];
+ };
+ "/rest/builds/0.1/bulk": {
+ /**
+ * Submit build data
+ * @description Update / insert builds data.
+ *
+ * Builds are identified by the combination of `pipelineId` and `buildNumber`, and existing build data for the same
+ * build will be replaced if it exists and the `updateSequenceNumber` of the existing data is less than the
+ * incoming data.
+ *
+ * Submissions are performed asynchronously. Submitted data will eventually be available in Jira; most updates are
+ * available within a short period of time, but may take some time during peak load and/or maintenance times.
+ * The `getBuildByKey` operation can be used to confirm that data has been stored successfully (if needed).
+ *
+ * In the case of multiple builds being submitted in one request, each is validated individually prior to
+ * submission. Details of which build failed submission (if any) are available in the response object.
+ *
+ * Only Connect apps that define the `jiraBuildInfoProvider` module, and on-premise integrations, can access this resource.
+ * This resource requires the 'WRITE' scope for Connect apps.
+ */
+ post: operations["submitBuilds"];
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that corresponds to an app installed in Jira.
+ *
+ * If the Connect JWT token corresponds to an app that does not define `jiraBuildInfoProvider` module it will be rejected with a 403.
+ *
+ * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens.
+ * See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations.
+ */
+ Authorization: string;
+ };
+ };
+ };
+ "/rest/builds/0.1/bulkByProperties": {
+ /**
+ * Delete builds by Property
+ * @description Bulk delete all builds data that match the given request.
+ *
+ * One or more query params must be supplied to specify Properties to delete by.
+ * Optional param `_updateSequenceNumber` is no longer supported.
+ * If more than one Property is provided, data will be deleted that matches ALL of the
+ * Properties (e.g. treated as an AND).
+ *
+ * See the documentation for the `submitBuilds` operation for more details.
+ *
+ * e.g. DELETE /bulkByProperties?accountId=account-123&repoId=repo-345
+ *
+ * Deletion is performed asynchronously. The `getBuildByKey` operation can be used to confirm that data has been
+ * deleted successfully (if needed).
+ *
+ * Only Connect apps that define the `jiraBuildInfoProvider` module, and on-premise integrations, can access this resource.
+ * This resource requires the 'DELETE' scope for Connect apps.
+ */
+ delete: operations["deleteBuildsByProperty"];
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that corresponds to an app installed in Jira.
+ *
+ * If the Connect JWT token corresponds to an app that does not define `jiraBuildInfoProvider` module it will be rejected with a 403.
+ *
+ * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens.
+ * See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations.
+ */
+ Authorization: string;
+ };
+ };
+ };
+ "/rest/builds/0.1/pipelines/{pipelineId}/builds/{buildNumber}": {
+ /**
+ * Get a build by key
+ * @description Retrieve the currently stored build data for the given `pipelineId` and `buildNumber` combination.
+ *
+ * The result will be what is currently stored, ignoring any pending updates or deletes.
+ *
+ * Only Connect apps that define the `jiraBuildInfoProvider` module, and on-premise integrations, can access this resource.
+ * This resource requires the 'READ' scope for Connect apps.
+ */
+ get: operations["getBuildByKey"];
+ /**
+ * Delete a build by key
+ * @description Delete the build data currently stored for the given `pipelineId` and `buildNumber` combination.
+ *
+ * Deletion is performed asynchronously. The `getBuildByKey` operation can be used to confirm that data has been
+ * deleted successfully (if needed).
+ *
+ * Only Connect apps that define the `jiraBuildInfoProvider` module, and on-premise integrations, can access this resource.
+ * This resource requires the 'DELETE' scope for Connect apps.
+ */
+ delete: operations["deleteBuildByKey"];
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that corresponds to an app installed in Jira.
+ *
+ * If the Connect JWT token corresponds to an app that does not define `jiraBuildInfoProvider` module it will be rejected with a 403.
+ *
+ * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens.
+ * See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations.
+ */
+ Authorization: string;
+ };
+ };
+ };
+ "/rest/remotelinks/1.0/bulk": {
+ /**
+ * Submit Remote Link data
+ * @description Update / insert Remote Link data.
+ *
+ * Remote Links are identified by their ID, existing Remote Link data for the same ID will be replaced if it
+ * exists and the updateSequenceId of existing data is less than the incoming data.
+ *
+ * Submissions are performed asynchronously. Submitted data will eventually be available in Jira; most updates are
+ * available within a short period of time, but may take some time during peak load and/or maintenance times.
+ * The `getRemoteLinkById` operation can be used to confirm that data has been stored successfully (if needed).
+ *
+ * In the case of multiple Remote Links being submitted in one request, each is validated individually prior to
+ * submission. Details of which Remote LInk failed submission (if any) are available in the response object.
+ *
+ * Only Connect apps that define the `jiraRemoteLinkInfoProvider` module can access this resource. This resource
+ * requires the 'WRITE' scope for Connect apps.
+ */
+ post: operations["submitRemoteLinks"];
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with a Connect JWT token that corresponds to an app installed in Jira.
+ *
+ * If the Connect JWT token corresponds to an app that does not define `jiraRemoteLinkInfoProvider` module it will be rejected with a 403.
+ *
+ * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens.
+ * See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations.
+ */
+ Authorization: string;
+ };
+ };
+ };
+ "/rest/remotelinks/1.0/bulkByProperties": {
+ /**
+ * Delete Remote Links by Property
+ * @description Bulk delete all Remote Links data that match the given request.
+ *
+ * One or more query params must be supplied to specify Properties to delete by.
+ * Optional param `_updateSequenceNumber` is no longer supported. If more than one Property is provided,
+ * data will be deleted that matches ALL of the Properties (e.g. treated as an AND).
+ *
+ * See the documentation for the `submitRemoteLinks` operation for more details.
+ *
+ * e.g. DELETE /bulkByProperties?accountId=account-123&repoId=repo-345
+ *
+ * Deletion is performed asynchronously. The `getRemoteLinkById` operation can be used to confirm that data has been
+ * deleted successfully (if needed).
+ *
+ * Only Connect apps that define the `jiraRemoteLinkInfoProvider` module, and on-premise integrations, can access this resource.
+ * This resource requires the 'DELETE' scope for Connect apps.
+ */
+ delete: operations["deleteRemoteLinksByProperty"];
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that
+ * corresponds to an app installed in Jira.
+ *
+ * If the Connect JWT token corresponds to an app that does not define `jiraRemoteLinkInfoProvider` module it will be rejected with a 403.
+ *
+ * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens.
+ * See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations.
+ */
+ Authorization: string;
+ };
+ };
+ };
+ "/rest/remotelinks/1.0/remotelink/{remoteLinkId}": {
+ /**
+ * Get a Remote Link by ID
+ * @description Retrieve the currently stored Remote Link data for the given ID.
+ *
+ * The result will be what is currently stored, ignoring any pending updates or deletes.
+ *
+ * Only Connect apps that define the `jiraRemoteLinkInfoProvider` module, and on-premise integrations, can access this resource.
+ * This resource requires the 'READ' scope for Connect apps.
+ */
+ get: operations["getRemoteLinkById"];
+ /**
+ * Delete a Remote Link by ID
+ * @description Delete the Remote Link data currently stored for the given ID.
+ *
+ * Deletion is performed asynchronously. The `getRemoteLinkById` operation can be used to confirm that data has been
+ * deleted successfully (if needed).
+ *
+ * Only Connect apps that define the `jiraRemoteLinkInfoProvider` module, and on-premise integrations, can access this resource.
+ * This resource requires the 'DELETE' scope for Connect apps.
+ */
+ delete: operations["deleteRemoteLinkById"];
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that
+ * corresponds to an app installed in Jira.
+ *
+ * If the Connect JWT token corresponds to an app that does not define `jiraRemoteLinkInfoProvider` module it will be rejected with a 403.
+ *
+ * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens.
+ * See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations.
+ */
+ Authorization: string;
+ };
+ };
+ };
+ "/rest/security/1.0/linkedWorkspaces/bulk": {
+ /**
+ * Submit Security Workspaces to link
+ * @description Insert Security Workspace IDs to establish a relationship between them and the Jira site the app is installed on. If a relationship between the workspace ID and Jira already exists then the workspace ID will be ignored and Jira will process the rest of the entries.
+ *
+ * Only Connect apps that define the `jiraSecurityInfoProvider` module can access this resource.
+ * This resource requires the 'WRITE' scope for Connect apps.
+ */
+ post: operations["submitWorkspaces"];
+ /**
+ * Delete linked Security Workspaces
+ * @description Bulk delete all linked Security Workspaces that match the given request.
+ *
+ * Only Connect apps that define the `jiraSecurityInfoProvider` module can access this resource.
+ * This resource requires the 'DELETE' scope for Connect apps.
+ *
+ * e.g. DELETE /bulk?workspaceIds=111-222-333,444-555-666
+ */
+ delete: operations["deleteLinkedWorkspaces"];
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with a Connect JWT token that corresponds to the Provider app installed in Jira.
+ *
+ * If the JWT token corresponds to an app that does not define the Security Information module it will be rejected with a 403.
+ *
+ * Read [understanding jwt](https://developer.atlassian.com/blog/2015/01/understanding-jwt/) for more details.
+ */
+ Authorization: string;
+ };
+ };
+ };
+ "/rest/security/1.0/linkedWorkspaces": {
+ /**
+ * Get linked Security Workspaces
+ * @description Retrieve all Security Workspaces linked with the Jira site.
+ *
+ * The result will be what is currently stored, ignoring any pending updates or deletes.
+ *
+ * Only Connect apps that define the `jiraSecurityInfoProvider` module can access this resource.
+ * This resource requires the 'READ' scope for Connect apps.
+ */
+ get: operations["getLinkedWorkspaces"];
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with a Connect JWT token that corresponds to the Provider app installed in Jira.
+ *
+ * If the JWT token corresponds to an app that does not define the Security Information module it will be rejected with a 403.
+ *
+ * Read more about JWT [here](https://developer.atlassian.com/blog/2015/01/understanding-jwt/).
+ */
+ Authorization: string;
+ };
+ };
+ };
+ "/rest/security/1.0/linkedWorkspaces/{workspaceId}": {
+ /**
+ * Get a linked Security Workspace by ID
+ * @description Retrieve a specific Security Workspace linked to the Jira site for the given workspace ID.
+ *
+ * The result will be what is currently stored, ignoring any pending updates or deletes.
+ *
+ * Only Connect apps that define the `jiraSecurityInfoProvider` module can access this resource.
+ * This resource requires the 'READ' scope for Connect apps.
+ */
+ get: operations["getLinkedWorkspaceById"];
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with a Connect JWT token that corresponds to the Provider app installed in Jira.
+ *
+ * If the JWT token corresponds to an app that does not define the Security Information module it will be rejected with a 403.
+ *
+ * Read more about JWT [here](https://developer.atlassian.com/blog/2015/01/understanding-jwt/).
+ */
+ Authorization: string;
+ };
+ };
+ };
+ "/rest/security/1.0/bulk": {
+ /**
+ * Submit Vulnerability data
+ * @description Update / Insert Vulnerability data.
+ *
+ * Vulnerabilities are identified by their ID, any existing Vulnerability data with the same ID will be replaced if it exists and the updateSequenceNumber of the existing data is less than the incoming data.
+ *
+ * Submissions are performed asynchronously. Most updates are available within a short period of time but may take some time during peak load and/or maintenance times. The GET vulnerability endpoint can be used to confirm that data has been stored successfully (if needed).
+ *
+ * In the case of multiple Vulnerabilities being submitted in one request, each is validated individually prior to submission. Details of Vulnerabilities that failed submission (if any) are available in the response object.
+ *
+ * A maximum of 1000 vulnerabilities can be submitted in one request.
+ *
+ * Only Connect apps that define the `jiraSecurityInfoProvider` module can access this resource.
+ * This resource requires the 'WRITE' scope for Connect apps.
+ */
+ post: operations["submitVulnerabilities"];
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with a Connect JWT token that corresponds to the Provider app installed in Jira.
+ *
+ * If the JWT token corresponds to an app that does not define the Security Information module it will be rejected with a 403.
+ *
+ * Read more about JWT [here](https://developer.atlassian.com/blog/2015/01/understanding-jwt/).
+ */
+ Authorization: string;
+ };
+ };
+ };
+ "/rest/security/1.0/bulkByProperties": {
+ /**
+ * Delete Vulnerabilities by Property
+ * @description Bulk delete all Vulnerabilities that match the given request.
+ *
+ * One or more query params must be supplied to specify Properties to delete by.
+ * If more than one Property is provided, data will be deleted that matches ALL of the Properties (e.g. treated as an AND).
+ * Read the POST bulk endpoint documentation for more details.
+ *
+ * e.g. DELETE /bulkByProperties?accountId=account-123&createdBy=user-456
+ *
+ * Deletion is performed asynchronously. The GET vulnerability endpoint can be used to confirm that data has been deleted successfully (if needed).
+ *
+ * Only Connect apps that define the `jiraSecurityInfoProvider` module can access this resource.
+ * This resource requires the 'DELETE' scope for Connect apps.
+ */
+ delete: operations["deleteVulnerabilitiesByProperty"];
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with a Connect JWT token that corresponds to the Provider app installed in Jira.
+ *
+ * If the JWT token corresponds to an app that does not define Security Information module it will be rejected with a 403.
+ *
+ * Read more about JWT [here](https://developer.atlassian.com/blog/2015/01/understanding-jwt/).
+ */
+ Authorization: string;
+ };
+ };
+ };
+ "/rest/security/1.0/vulnerability/{vulnerabilityId}": {
+ /**
+ * Get a Vulnerability by ID
+ * @description Retrieve the currently stored Vulnerability data for the given ID.
+ *
+ * The result will be what is currently stored, ignoring any pending updates or deletes.
+ *
+ * Only Connect apps that define the `jiraSecurityInfoProvider` module can access this resource.
+ * This resource requires the 'READ' scope for Connect apps.
+ */
+ get: operations["getVulnerabilityById"];
+ /**
+ * Delete a Vulnerability by ID
+ * @description Delete the Vulnerability data currently stored for the given ID.
+ *
+ * Deletion is performed asynchronously. The GET vulnerability endpoint can be used to confirm that data has been deleted successfully (if needed).
+ *
+ * Only Connect apps that define the `jiraSecurityInfoProvider` module can access this resource.
+ * This resource requires the 'DELETE' scope for Connect apps.
+ */
+ delete: operations["deleteVulnerabilityById"];
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with a Connect JWT token that corresponds to the Provider app installed in Jira.
+ *
+ * If the JWT token corresponds to an app that does not define Security Information module it will be rejected with a 403.
+ *
+ * Read more about JWT [here](https://developer.atlassian.com/blog/2015/01/understanding-jwt/).
+ */
+ Authorization: string;
+ };
+ };
+ };
+}
+
+export type webhooks = Record;
+
+export interface components {
+ schemas: {
+ StringList: Record;
+ IssueAssignRequestBean: {
+ issues?: string[];
+ };
+ EpicRankRequestBean: {
+ rankBeforeEpic?: string;
+ rankAfterEpic?: string;
+ /** Format: int64 */
+ rankCustomFieldId?: number;
+ };
+ ColorBean: {
+ /** @enum {string} */
+ key?:
+ | "color_1"
+ | "color_2"
+ | "color_3"
+ | "color_4"
+ | "color_5"
+ | "color_6"
+ | "color_7"
+ | "color_8"
+ | "color_9"
+ | "color_10"
+ | "color_11"
+ | "color_12"
+ | "color_13"
+ | "color_14";
+ };
+ EpicUpdateBean: {
+ name?: string;
+ summary?: string;
+ color?: {
+ /** @enum {string} */
+ key?:
+ | "color_1"
+ | "color_2"
+ | "color_3"
+ | "color_4"
+ | "color_5"
+ | "color_6"
+ | "color_7"
+ | "color_8"
+ | "color_9"
+ | "color_10"
+ | "color_11"
+ | "color_12"
+ | "color_13"
+ | "color_14";
+ };
+ done?: boolean;
+ };
+ ReportBean: Record;
+ ReportsResponseBean: {
+ reports?: Record[];
+ };
+ SprintCreateBean: {
+ name?: string;
+ startDate?: string;
+ endDate?: string;
+ /** Format: int64 */
+ originBoardId?: number;
+ goal?: string;
+ };
+ SprintBean: {
+ /** Format: int64 */
+ id?: number;
+ /** Format: uri */
+ self?: string;
+ state?: string;
+ name?: string;
+ startDate?: string;
+ endDate?: string;
+ completeDate?: string;
+ createdDate?: string;
+ /** Format: int64 */
+ originBoardId?: number;
+ goal?: string;
+ };
+ IssueRankRequestBean: {
+ issues?: string[];
+ rankBeforeIssue?: string;
+ rankAfterIssue?: string;
+ /** Format: int64 */
+ rankCustomFieldId?: number;
+ };
+ SprintSwapBean: {
+ /** Format: int64 */
+ sprintToSwapWith?: number;
+ };
+ PageBeanQuickFilterBean: {
+ /** Format: int32 */
+ maxResults?: number;
+ /** Format: int64 */
+ startAt?: number;
+ /** Format: int64 */
+ total?: number;
+ isLast?: boolean;
+ values?: {
+ /** Format: int64 */
+ id?: number;
+ /** Format: int64 */
+ boardId?: number;
+ name?: string;
+ jql?: string;
+ description?: string;
+ /** Format: int32 */
+ position?: number;
+ }[];
+ };
+ QuickFilterBean: {
+ /** Format: int64 */
+ id?: number;
+ /** Format: int64 */
+ boardId?: number;
+ name?: string;
+ jql?: string;
+ description?: string;
+ /** Format: int32 */
+ position?: number;
+ };
+ /** @description Details about a board. */
+ Board: {
+ /**
+ * Format: int64
+ * @description The ID of the board.
+ */
+ id?: number;
+ /**
+ * Format: uri
+ * @description The URL of the board.
+ */
+ self?: string;
+ /** @description The name of the board. */
+ name?: string;
+ /** @description The type the board. */
+ type?: string;
+ admins?: {
+ users?: {
+ /**
+ * @description This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
+ * The key of the user.
+ */
+ key?: string;
+ /**
+ * Format: uri
+ * @description The URL of the user.
+ */
+ self?: string;
+ /**
+ * @description This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
+ * The username of the user.
+ */
+ name?: string;
+ /** @description The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. */
+ displayName?: string;
+ /** @description Whether the user is active. */
+ active?: boolean;
+ /** @description The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. */
+ accountId?: string;
+ /** @description The avatars of the user. */
+ avatarUrls?: {
+ /**
+ * Format: uri
+ * @description The URL of the user's 24x24 pixel avatar.
+ */
+ "24x24"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the user's 32x32 pixel avatar.
+ */
+ "32x32"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the user's 48x48 pixel avatar.
+ */
+ "48x48"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the user's 16x16 pixel avatar.
+ */
+ "16x16"?: string;
+ };
+ }[];
+ groups?: {
+ name?: string;
+ /** Format: uri */
+ self?: string;
+ }[];
+ };
+ /** @description The container that the board is located in. */
+ location?: {
+ /** Format: int64 */
+ projectId?: number;
+ /** Format: int64 */
+ userId?: number;
+ userAccountId?: string;
+ displayName?: string;
+ projectName?: string;
+ projectKey?: string;
+ projectTypeKey?: string;
+ /** Format: uri */
+ avatarURI?: string;
+ name?: string;
+ };
+ /** @description Whether the board can be edited. */
+ canEdit?: boolean;
+ /** @description Whether the board is private. */
+ isPrivate?: boolean;
+ /** @description Whether the board is selected as a favorite. */
+ favourite?: boolean;
+ };
+ /** @description The users and groups who own the board. */
+ BoardAdminsBean: {
+ users?: {
+ /**
+ * @description This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
+ * The key of the user.
+ */
+ key?: string;
+ /**
+ * Format: uri
+ * @description The URL of the user.
+ */
+ self?: string;
+ /**
+ * @description This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
+ * The username of the user.
+ */
+ name?: string;
+ /** @description The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. */
+ displayName?: string;
+ /** @description Whether the user is active. */
+ active?: boolean;
+ /** @description The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. */
+ accountId?: string;
+ /** @description The avatars of the user. */
+ avatarUrls?: {
+ /**
+ * Format: uri
+ * @description The URL of the user's 24x24 pixel avatar.
+ */
+ "24x24"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the user's 32x32 pixel avatar.
+ */
+ "32x32"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the user's 48x48 pixel avatar.
+ */
+ "48x48"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the user's 16x16 pixel avatar.
+ */
+ "16x16"?: string;
+ };
+ }[];
+ groups?: {
+ name?: string;
+ /** Format: uri */
+ self?: string;
+ }[];
+ };
+ /** @description The container that the board is located in. */
+ BoardLocationBean: {
+ /** Format: int64 */
+ projectId?: number;
+ /** Format: int64 */
+ userId?: number;
+ userAccountId?: string;
+ displayName?: string;
+ projectName?: string;
+ projectKey?: string;
+ projectTypeKey?: string;
+ /** Format: uri */
+ avatarURI?: string;
+ name?: string;
+ };
+ GroupBean: {
+ name?: string;
+ /** Format: uri */
+ self?: string;
+ };
+ PageBeanBoard: {
+ /** Format: int32 */
+ maxResults?: number;
+ /** Format: int64 */
+ startAt?: number;
+ /** Format: int64 */
+ total?: number;
+ isLast?: boolean;
+ values?: {
+ /**
+ * Format: int64
+ * @description The ID of the board.
+ */
+ id?: number;
+ /**
+ * Format: uri
+ * @description The URL of the board.
+ */
+ self?: string;
+ /** @description The name of the board. */
+ name?: string;
+ /** @description The type the board. */
+ type?: string;
+ admins?: {
+ users?: {
+ /**
+ * @description This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
+ * The key of the user.
+ */
+ key?: string;
+ /**
+ * Format: uri
+ * @description The URL of the user.
+ */
+ self?: string;
+ /**
+ * @description This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
+ * The username of the user.
+ */
+ name?: string;
+ /** @description The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. */
+ displayName?: string;
+ /** @description Whether the user is active. */
+ active?: boolean;
+ /** @description The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. */
+ accountId?: string;
+ /** @description The avatars of the user. */
+ avatarUrls?: {
+ /**
+ * Format: uri
+ * @description The URL of the user's 24x24 pixel avatar.
+ */
+ "24x24"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the user's 32x32 pixel avatar.
+ */
+ "32x32"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the user's 48x48 pixel avatar.
+ */
+ "48x48"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the user's 16x16 pixel avatar.
+ */
+ "16x16"?: string;
+ };
+ }[];
+ groups?: {
+ name?: string;
+ /** Format: uri */
+ self?: string;
+ }[];
+ };
+ /** @description The container that the board is located in. */
+ location?: {
+ /** Format: int64 */
+ projectId?: number;
+ /** Format: int64 */
+ userId?: number;
+ userAccountId?: string;
+ displayName?: string;
+ projectName?: string;
+ projectKey?: string;
+ projectTypeKey?: string;
+ /** Format: uri */
+ avatarURI?: string;
+ name?: string;
+ };
+ /** @description Whether the board can be edited. */
+ canEdit?: boolean;
+ /** @description Whether the board is private. */
+ isPrivate?: boolean;
+ /** @description Whether the board is selected as a favorite. */
+ favourite?: boolean;
+ }[];
+ };
+ UserBean: {
+ /**
+ * @description This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
+ * The key of the user.
+ */
+ key?: string;
+ /**
+ * Format: uri
+ * @description The URL of the user.
+ */
+ self?: string;
+ /**
+ * @description This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
+ * The username of the user.
+ */
+ name?: string;
+ /** @description The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. */
+ displayName?: string;
+ /** @description Whether the user is active. */
+ active?: boolean;
+ /** @description The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. */
+ accountId?: string;
+ /** @description The avatars of the user. */
+ avatarUrls?: {
+ /**
+ * Format: uri
+ * @description The URL of the user's 24x24 pixel avatar.
+ */
+ "24x24"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the user's 32x32 pixel avatar.
+ */
+ "32x32"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the user's 48x48 pixel avatar.
+ */
+ "48x48"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the user's 16x16 pixel avatar.
+ */
+ "16x16"?: string;
+ };
+ };
+ UserBeanAvatarUrls: {
+ /**
+ * Format: uri
+ * @description The URL of the user's 24x24 pixel avatar.
+ */
+ "24x24"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the user's 32x32 pixel avatar.
+ */
+ "32x32"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the user's 48x48 pixel avatar.
+ */
+ "48x48"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the user's 16x16 pixel avatar.
+ */
+ "16x16"?: string;
+ };
+ BoardFilterBean: {
+ /** Format: int64 */
+ id?: number;
+ /** Format: uri */
+ self?: string;
+ name?: string;
+ };
+ PageBeanBoardFilterBean: {
+ /** Format: int32 */
+ maxResults?: number;
+ /** Format: int64 */
+ startAt?: number;
+ /** Format: int64 */
+ total?: number;
+ isLast?: boolean;
+ values?: {
+ /** Format: int64 */
+ id?: number;
+ /** Format: uri */
+ self?: string;
+ name?: string;
+ }[];
+ };
+ AvatarUrlsBean: {
+ /**
+ * Format: uri
+ * @description The URL of the item's 16x16 pixel avatar.
+ */
+ "16x16"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the item's 24x24 pixel avatar.
+ */
+ "24x24"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the item's 32x32 pixel avatar.
+ */
+ "32x32"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the item's 48x48 pixel avatar.
+ */
+ "48x48"?: string;
+ };
+ /** @description A change item. */
+ ChangeDetails: {
+ /** @description The name of the field changed. */
+ field?: string;
+ /** @description The type of the field changed. */
+ fieldtype?: string;
+ /** @description The ID of the field changed. */
+ fieldId?: string;
+ /** @description The details of the original value. */
+ from?: string;
+ /** @description The details of the original value as a string. */
+ fromString?: string;
+ /** @description The details of the new value. */
+ to?: string;
+ /** @description The details of the new value as a string. */
+ toString?: string;
+ };
+ /** @description A changelog. */
+ Changelog: {
+ /** @description The ID of the changelog. */
+ id?: string;
+ /** @description The user who made the change. */
+ author?: {
+ /** @description The URL of the user. */
+ self?: string;
+ /** @description This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. */
+ name?: string;
+ /** @description This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. */
+ key?: string;
+ /** @description The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. */
+ accountId?: string;
+ /** @description The email address of the user. Depending on the user’s privacy settings, this may be returned as null. */
+ emailAddress?: string;
+ /** @description The avatars of the user. */
+ avatarUrls?: {
+ /**
+ * Format: uri
+ * @description The URL of the item's 16x16 pixel avatar.
+ */
+ "16x16"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the item's 24x24 pixel avatar.
+ */
+ "24x24"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the item's 32x32 pixel avatar.
+ */
+ "32x32"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the item's 48x48 pixel avatar.
+ */
+ "48x48"?: string;
+ };
+ /** @description The display name of the user. Depending on the user’s privacy settings, this may return an alternative value. */
+ displayName?: string;
+ /** @description Whether the user is active. */
+ active?: boolean;
+ /** @description The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null. */
+ timeZone?: string;
+ /** @description 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) */
+ accountType?: string;
+ };
+ /**
+ * Format: date-time
+ * @description The date on which the change took place.
+ */
+ created?: string;
+ /** @description The list of items changed. */
+ items?: readonly {
+ /** @description The name of the field changed. */
+ field?: string;
+ /** @description The type of the field changed. */
+ fieldtype?: string;
+ /** @description The ID of the field changed. */
+ fieldId?: string;
+ /** @description The details of the original value. */
+ from?: string;
+ /** @description The details of the original value as a string. */
+ fromString?: string;
+ /** @description The details of the new value. */
+ to?: string;
+ /** @description The details of the new value as a string. */
+ toString?: string;
+ }[];
+ /** @description The history metadata associated with the changed. */
+ historyMetadata?: {
+ /** @description The type of the history record. */
+ type?: string;
+ /** @description The description of the history record. */
+ description?: string;
+ /** @description The description key of the history record. */
+ descriptionKey?: string;
+ /** @description The activity described in the history record. */
+ activityDescription?: string;
+ /** @description The key of the activity described in the history record. */
+ activityDescriptionKey?: string;
+ /** @description The description of the email address associated the history record. */
+ emailDescription?: string;
+ /** @description The description key of the email address associated the history record. */
+ emailDescriptionKey?: string;
+ /** @description Details of the user whose action created the history record. */
+ actor?: {
+ /** @description The ID of the user or system associated with a history record. */
+ id?: string;
+ /** @description The display name of the user or system associated with a history record. */
+ displayName?: string;
+ /** @description The key of the display name of the user or system associated with a history record. */
+ displayNameKey?: string;
+ /** @description The type of the user or system associated with a history record. */
+ type?: string;
+ /** @description The URL to an avatar for the user or system associated with a history record. */
+ avatarUrl?: string;
+ /** @description The URL of the user or system associated with a history record. */
+ url?: string;
+ [key: string]: unknown;
+ };
+ /** @description Details of the system that generated the history record. */
+ generator?: {
+ /** @description The ID of the user or system associated with a history record. */
+ id?: string;
+ /** @description The display name of the user or system associated with a history record. */
+ displayName?: string;
+ /** @description The key of the display name of the user or system associated with a history record. */
+ displayNameKey?: string;
+ /** @description The type of the user or system associated with a history record. */
+ type?: string;
+ /** @description The URL to an avatar for the user or system associated with a history record. */
+ avatarUrl?: string;
+ /** @description The URL of the user or system associated with a history record. */
+ url?: string;
+ [key: string]: unknown;
+ };
+ /** @description Details of the cause that triggered the creation the history record. */
+ cause?: {
+ /** @description The ID of the user or system associated with a history record. */
+ id?: string;
+ /** @description The display name of the user or system associated with a history record. */
+ displayName?: string;
+ /** @description The key of the display name of the user or system associated with a history record. */
+ displayNameKey?: string;
+ /** @description The type of the user or system associated with a history record. */
+ type?: string;
+ /** @description The URL to an avatar for the user or system associated with a history record. */
+ avatarUrl?: string;
+ /** @description The URL of the user or system associated with a history record. */
+ url?: string;
+ [key: string]: unknown;
+ };
+ /** @description Additional arbitrary information about the history record. */
+ extraData?: {
+ [key: string]: string;
+ };
+ [key: string]: unknown;
+ };
+ };
+ /** @description The metadata describing an issue field. */
+ FieldMetadata: {
+ /** @description Whether the field is required. */
+ required: boolean;
+ /** @description The data type of the field. */
+ schema: {
+ /** @description The data type of the field. */
+ type: string;
+ /** @description When the data type is an array, the name of the field items within the array. */
+ items?: string;
+ /** @description If the field is a system field, the name of the field. */
+ system?: string;
+ /** @description If the field is a custom field, the URI of the field. */
+ custom?: string;
+ /**
+ * Format: int64
+ * @description If the field is a custom field, the custom ID of the field.
+ */
+ customId?: number;
+ /** @description If the field is a custom field, the configuration of the field. */
+ configuration?: {
+ [key: string]: unknown;
+ };
+ };
+ /** @description The name of the field. */
+ name: string;
+ /** @description The key of the field. */
+ key: string;
+ /** @description The URL that can be used to automatically complete the field. */
+ autoCompleteUrl?: string;
+ /** @description Whether the field has a default value. */
+ hasDefaultValue?: boolean;
+ /** @description The list of operations that can be performed on the field. */
+ operations: readonly string[];
+ /** @description The list of values allowed in the field. */
+ allowedValues?: readonly unknown[];
+ /** @description The default value of the field. */
+ defaultValue?: unknown;
+ /** @description The configuration properties. */
+ configuration?: {
+ [key: string]: unknown;
+ };
+ };
+ /** @description Details of issue history metadata. */
+ HistoryMetadata: {
+ /** @description The type of the history record. */
+ type?: string;
+ /** @description The description of the history record. */
+ description?: string;
+ /** @description The description key of the history record. */
+ descriptionKey?: string;
+ /** @description The activity described in the history record. */
+ activityDescription?: string;
+ /** @description The key of the activity described in the history record. */
+ activityDescriptionKey?: string;
+ /** @description The description of the email address associated the history record. */
+ emailDescription?: string;
+ /** @description The description key of the email address associated the history record. */
+ emailDescriptionKey?: string;
+ /** @description Details of the user whose action created the history record. */
+ actor?: {
+ /** @description The ID of the user or system associated with a history record. */
+ id?: string;
+ /** @description The display name of the user or system associated with a history record. */
+ displayName?: string;
+ /** @description The key of the display name of the user or system associated with a history record. */
+ displayNameKey?: string;
+ /** @description The type of the user or system associated with a history record. */
+ type?: string;
+ /** @description The URL to an avatar for the user or system associated with a history record. */
+ avatarUrl?: string;
+ /** @description The URL of the user or system associated with a history record. */
+ url?: string;
+ [key: string]: unknown;
+ };
+ /** @description Details of the system that generated the history record. */
+ generator?: {
+ /** @description The ID of the user or system associated with a history record. */
+ id?: string;
+ /** @description The display name of the user or system associated with a history record. */
+ displayName?: string;
+ /** @description The key of the display name of the user or system associated with a history record. */
+ displayNameKey?: string;
+ /** @description The type of the user or system associated with a history record. */
+ type?: string;
+ /** @description The URL to an avatar for the user or system associated with a history record. */
+ avatarUrl?: string;
+ /** @description The URL of the user or system associated with a history record. */
+ url?: string;
+ [key: string]: unknown;
+ };
+ /** @description Details of the cause that triggered the creation the history record. */
+ cause?: {
+ /** @description The ID of the user or system associated with a history record. */
+ id?: string;
+ /** @description The display name of the user or system associated with a history record. */
+ displayName?: string;
+ /** @description The key of the display name of the user or system associated with a history record. */
+ displayNameKey?: string;
+ /** @description The type of the user or system associated with a history record. */
+ type?: string;
+ /** @description The URL to an avatar for the user or system associated with a history record. */
+ avatarUrl?: string;
+ /** @description The URL of the user or system associated with a history record. */
+ url?: string;
+ [key: string]: unknown;
+ };
+ /** @description Additional arbitrary information about the history record. */
+ extraData?: {
+ [key: string]: string;
+ };
+ [key: string]: unknown;
+ };
+ /** @description Details of user or system associated with a issue history metadata item. */
+ HistoryMetadataParticipant: {
+ /** @description The ID of the user or system associated with a history record. */
+ id?: string;
+ /** @description The display name of the user or system associated with a history record. */
+ displayName?: string;
+ /** @description The key of the display name of the user or system associated with a history record. */
+ displayNameKey?: string;
+ /** @description The type of the user or system associated with a history record. */
+ type?: string;
+ /** @description The URL to an avatar for the user or system associated with a history record. */
+ avatarUrl?: string;
+ /** @description The URL of the user or system associated with a history record. */
+ url?: string;
+ [key: string]: unknown;
+ };
+ IncludedFields: {
+ included?: string[];
+ actuallyIncluded?: string[];
+ excluded?: string[];
+ };
+ /** @description Details about an issue. */
+ IssueBean: {
+ /** @description Expand options that include additional issue details in the response. */
+ expand?: string;
+ /** @description The ID of the issue. */
+ id?: string;
+ /**
+ * Format: uri
+ * @description The URL of the issue details.
+ */
+ self?: string;
+ /** @description The key of the issue. */
+ key?: string;
+ /** @description The rendered value of each field present on the issue. */
+ renderedFields?: {
+ [key: string]: unknown;
+ };
+ /** @description Details of the issue properties identified in the request. */
+ properties?: {
+ [key: string]: unknown;
+ };
+ /** @description The ID and name of each field present on the issue. */
+ names?: {
+ [key: string]: string;
+ };
+ /** @description The schema describing each field present on the issue. */
+ schema?: {
+ [key: string]: {
+ /** @description The data type of the field. */
+ type: string;
+ /** @description When the data type is an array, the name of the field items within the array. */
+ items?: string;
+ /** @description If the field is a system field, the name of the field. */
+ system?: string;
+ /** @description If the field is a custom field, the URI of the field. */
+ custom?: string;
+ /**
+ * Format: int64
+ * @description If the field is a custom field, the custom ID of the field.
+ */
+ customId?: number;
+ /** @description If the field is a custom field, the configuration of the field. */
+ configuration?: {
+ [key: string]: unknown;
+ };
+ };
+ };
+ /** @description The transitions that can be performed on the issue. */
+ transitions?: readonly {
+ /** @description The ID of the issue transition. Required when specifying a transition to undertake. */
+ id?: string;
+ /** @description The name of the issue transition. */
+ name?: string;
+ /** @description Details of the issue status after the transition. */
+ to?: {
+ /** @description The URL of the status. */
+ self?: string;
+ /** @description The description of the status. */
+ description?: string;
+ /** @description The URL of the icon used to represent the status. */
+ iconUrl?: string;
+ /** @description The name of the status. */
+ name?: string;
+ /** @description The ID of the status. */
+ id?: string;
+ /** @description The category assigned to the status. */
+ statusCategory?: {
+ /** @description The URL of the status category. */
+ self?: string;
+ /**
+ * Format: int64
+ * @description The ID of the status category.
+ */
+ id?: number;
+ /** @description The key of the status category. */
+ key?: string;
+ /** @description The name of the color used to represent the status category. */
+ colorName?: string;
+ /** @description The name of the status category. */
+ name?: string;
+ [key: string]: unknown;
+ };
+ [key: string]: unknown;
+ };
+ /** @description Whether there is a screen associated with the issue transition. */
+ hasScreen?: boolean;
+ /** @description Whether the issue transition is global, that is, the transition is applied to issues regardless of their status. */
+ isGlobal?: boolean;
+ /** @description Whether this is the initial issue transition for the workflow. */
+ isInitial?: boolean;
+ /** @description Whether the transition is available to be performed. */
+ isAvailable?: boolean;
+ /** @description Whether the issue has to meet criteria before the issue transition is applied. */
+ isConditional?: boolean;
+ /** @description Details of the fields associated with the issue transition screen. Use this information to populate `fields` and `update` in a transition request. */
+ fields?: {
+ [key: string]: {
+ /** @description Whether the field is required. */
+ required: boolean;
+ /** @description The data type of the field. */
+ schema: {
+ /** @description The data type of the field. */
+ type: string;
+ /** @description When the data type is an array, the name of the field items within the array. */
+ items?: string;
+ /** @description If the field is a system field, the name of the field. */
+ system?: string;
+ /** @description If the field is a custom field, the URI of the field. */
+ custom?: string;
+ /**
+ * Format: int64
+ * @description If the field is a custom field, the custom ID of the field.
+ */
+ customId?: number;
+ /** @description If the field is a custom field, the configuration of the field. */
+ configuration?: {
+ [key: string]: unknown;
+ };
+ };
+ /** @description The name of the field. */
+ name: string;
+ /** @description The key of the field. */
+ key: string;
+ /** @description The URL that can be used to automatically complete the field. */
+ autoCompleteUrl?: string;
+ /** @description Whether the field has a default value. */
+ hasDefaultValue?: boolean;
+ /** @description The list of operations that can be performed on the field. */
+ operations: readonly string[];
+ /** @description The list of values allowed in the field. */
+ allowedValues?: readonly unknown[];
+ /** @description The default value of the field. */
+ defaultValue?: unknown;
+ /** @description The configuration properties. */
+ configuration?: {
+ [key: string]: unknown;
+ };
+ };
+ };
+ /** @description Expand options that include additional transition details in the response. */
+ expand?: string;
+ looped?: boolean;
+ [key: string]: unknown;
+ }[];
+ /** @description The operations that can be performed on the issue. */
+ operations?: components["schemas"]["Operations"];
+ /** @description The metadata for the fields on the issue that can be amended. */
+ editmeta?: {
+ fields?: {
+ [key: string]: {
+ /** @description Whether the field is required. */
+ required: boolean;
+ /** @description The data type of the field. */
+ schema: {
+ /** @description The data type of the field. */
+ type: string;
+ /** @description When the data type is an array, the name of the field items within the array. */
+ items?: string;
+ /** @description If the field is a system field, the name of the field. */
+ system?: string;
+ /** @description If the field is a custom field, the URI of the field. */
+ custom?: string;
+ /**
+ * Format: int64
+ * @description If the field is a custom field, the custom ID of the field.
+ */
+ customId?: number;
+ /** @description If the field is a custom field, the configuration of the field. */
+ configuration?: {
+ [key: string]: unknown;
+ };
+ };
+ /** @description The name of the field. */
+ name: string;
+ /** @description The key of the field. */
+ key: string;
+ /** @description The URL that can be used to automatically complete the field. */
+ autoCompleteUrl?: string;
+ /** @description Whether the field has a default value. */
+ hasDefaultValue?: boolean;
+ /** @description The list of operations that can be performed on the field. */
+ operations: readonly string[];
+ /** @description The list of values allowed in the field. */
+ allowedValues?: readonly unknown[];
+ /** @description The default value of the field. */
+ defaultValue?: unknown;
+ /** @description The configuration properties. */
+ configuration?: {
+ [key: string]: unknown;
+ };
+ };
+ };
+ };
+ /** @description Details of changelogs associated with the issue. */
+ changelog?: {
+ /**
+ * Format: int32
+ * @description The index of the first item returned on the page.
+ */
+ startAt?: number;
+ /**
+ * Format: int32
+ * @description The maximum number of results that could be on the page.
+ */
+ maxResults?: number;
+ /**
+ * Format: int32
+ * @description The number of results on the page.
+ */
+ total?: number;
+ /** @description The list of changelogs. */
+ histories?: readonly {
+ /** @description The ID of the changelog. */
+ id?: string;
+ /** @description The user who made the change. */
+ author?: {
+ /** @description The URL of the user. */
+ self?: string;
+ /** @description This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. */
+ name?: string;
+ /** @description This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. */
+ key?: string;
+ /** @description The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. */
+ accountId?: string;
+ /** @description The email address of the user. Depending on the user’s privacy settings, this may be returned as null. */
+ emailAddress?: string;
+ /** @description The avatars of the user. */
+ avatarUrls?: {
+ /**
+ * Format: uri
+ * @description The URL of the item's 16x16 pixel avatar.
+ */
+ "16x16"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the item's 24x24 pixel avatar.
+ */
+ "24x24"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the item's 32x32 pixel avatar.
+ */
+ "32x32"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the item's 48x48 pixel avatar.
+ */
+ "48x48"?: string;
+ };
+ /** @description The display name of the user. Depending on the user’s privacy settings, this may return an alternative value. */
+ displayName?: string;
+ /** @description Whether the user is active. */
+ active?: boolean;
+ /** @description The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null. */
+ timeZone?: string;
+ /** @description 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) */
+ accountType?: string;
+ };
+ /**
+ * Format: date-time
+ * @description The date on which the change took place.
+ */
+ created?: string;
+ /** @description The list of items changed. */
+ items?: readonly {
+ /** @description The name of the field changed. */
+ field?: string;
+ /** @description The type of the field changed. */
+ fieldtype?: string;
+ /** @description The ID of the field changed. */
+ fieldId?: string;
+ /** @description The details of the original value. */
+ from?: string;
+ /** @description The details of the original value as a string. */
+ fromString?: string;
+ /** @description The details of the new value. */
+ to?: string;
+ /** @description The details of the new value as a string. */
+ toString?: string;
+ }[];
+ /** @description The history metadata associated with the changed. */
+ historyMetadata?: {
+ /** @description The type of the history record. */
+ type?: string;
+ /** @description The description of the history record. */
+ description?: string;
+ /** @description The description key of the history record. */
+ descriptionKey?: string;
+ /** @description The activity described in the history record. */
+ activityDescription?: string;
+ /** @description The key of the activity described in the history record. */
+ activityDescriptionKey?: string;
+ /** @description The description of the email address associated the history record. */
+ emailDescription?: string;
+ /** @description The description key of the email address associated the history record. */
+ emailDescriptionKey?: string;
+ /** @description Details of the user whose action created the history record. */
+ actor?: {
+ /** @description The ID of the user or system associated with a history record. */
+ id?: string;
+ /** @description The display name of the user or system associated with a history record. */
+ displayName?: string;
+ /** @description The key of the display name of the user or system associated with a history record. */
+ displayNameKey?: string;
+ /** @description The type of the user or system associated with a history record. */
+ type?: string;
+ /** @description The URL to an avatar for the user or system associated with a history record. */
+ avatarUrl?: string;
+ /** @description The URL of the user or system associated with a history record. */
+ url?: string;
+ [key: string]: unknown;
+ };
+ /** @description Details of the system that generated the history record. */
+ generator?: {
+ /** @description The ID of the user or system associated with a history record. */
+ id?: string;
+ /** @description The display name of the user or system associated with a history record. */
+ displayName?: string;
+ /** @description The key of the display name of the user or system associated with a history record. */
+ displayNameKey?: string;
+ /** @description The type of the user or system associated with a history record. */
+ type?: string;
+ /** @description The URL to an avatar for the user or system associated with a history record. */
+ avatarUrl?: string;
+ /** @description The URL of the user or system associated with a history record. */
+ url?: string;
+ [key: string]: unknown;
+ };
+ /** @description Details of the cause that triggered the creation the history record. */
+ cause?: {
+ /** @description The ID of the user or system associated with a history record. */
+ id?: string;
+ /** @description The display name of the user or system associated with a history record. */
+ displayName?: string;
+ /** @description The key of the display name of the user or system associated with a history record. */
+ displayNameKey?: string;
+ /** @description The type of the user or system associated with a history record. */
+ type?: string;
+ /** @description The URL to an avatar for the user or system associated with a history record. */
+ avatarUrl?: string;
+ /** @description The URL of the user or system associated with a history record. */
+ url?: string;
+ [key: string]: unknown;
+ };
+ /** @description Additional arbitrary information about the history record. */
+ extraData?: {
+ [key: string]: string;
+ };
+ [key: string]: unknown;
+ };
+ }[];
+ };
+ /** @description The versions of each field on the issue. */
+ versionedRepresentations?: {
+ [key: string]: {
+ [key: string]: unknown;
+ };
+ };
+ fieldsToInclude?: {
+ included?: string[];
+ actuallyIncluded?: string[];
+ excluded?: string[];
+ };
+ fields?: {
+ [key: string]: unknown;
+ };
+ };
+ /** @description Details of an issue transition. */
+ IssueTransition: {
+ /** @description The ID of the issue transition. Required when specifying a transition to undertake. */
+ id?: string;
+ /** @description The name of the issue transition. */
+ name?: string;
+ /** @description Details of the issue status after the transition. */
+ to?: {
+ /** @description The URL of the status. */
+ self?: string;
+ /** @description The description of the status. */
+ description?: string;
+ /** @description The URL of the icon used to represent the status. */
+ iconUrl?: string;
+ /** @description The name of the status. */
+ name?: string;
+ /** @description The ID of the status. */
+ id?: string;
+ /** @description The category assigned to the status. */
+ statusCategory?: {
+ /** @description The URL of the status category. */
+ self?: string;
+ /**
+ * Format: int64
+ * @description The ID of the status category.
+ */
+ id?: number;
+ /** @description The key of the status category. */
+ key?: string;
+ /** @description The name of the color used to represent the status category. */
+ colorName?: string;
+ /** @description The name of the status category. */
+ name?: string;
+ [key: string]: unknown;
+ };
+ [key: string]: unknown;
+ };
+ /** @description Whether there is a screen associated with the issue transition. */
+ hasScreen?: boolean;
+ /** @description Whether the issue transition is global, that is, the transition is applied to issues regardless of their status. */
+ isGlobal?: boolean;
+ /** @description Whether this is the initial issue transition for the workflow. */
+ isInitial?: boolean;
+ /** @description Whether the transition is available to be performed. */
+ isAvailable?: boolean;
+ /** @description Whether the issue has to meet criteria before the issue transition is applied. */
+ isConditional?: boolean;
+ /** @description Details of the fields associated with the issue transition screen. Use this information to populate `fields` and `update` in a transition request. */
+ fields?: {
+ [key: string]: {
+ /** @description Whether the field is required. */
+ required: boolean;
+ /** @description The data type of the field. */
+ schema: {
+ /** @description The data type of the field. */
+ type: string;
+ /** @description When the data type is an array, the name of the field items within the array. */
+ items?: string;
+ /** @description If the field is a system field, the name of the field. */
+ system?: string;
+ /** @description If the field is a custom field, the URI of the field. */
+ custom?: string;
+ /**
+ * Format: int64
+ * @description If the field is a custom field, the custom ID of the field.
+ */
+ customId?: number;
+ /** @description If the field is a custom field, the configuration of the field. */
+ configuration?: {
+ [key: string]: unknown;
+ };
+ };
+ /** @description The name of the field. */
+ name: string;
+ /** @description The key of the field. */
+ key: string;
+ /** @description The URL that can be used to automatically complete the field. */
+ autoCompleteUrl?: string;
+ /** @description Whether the field has a default value. */
+ hasDefaultValue?: boolean;
+ /** @description The list of operations that can be performed on the field. */
+ operations: readonly string[];
+ /** @description The list of values allowed in the field. */
+ allowedValues?: readonly unknown[];
+ /** @description The default value of the field. */
+ defaultValue?: unknown;
+ /** @description The configuration properties. */
+ configuration?: {
+ [key: string]: unknown;
+ };
+ };
+ };
+ /** @description Expand options that include additional transition details in the response. */
+ expand?: string;
+ looped?: boolean;
+ [key: string]: unknown;
+ };
+ /** @description A list of editable field details. */
+ IssueUpdateMetadata: {
+ fields?: {
+ [key: string]: {
+ /** @description Whether the field is required. */
+ required: boolean;
+ /** @description The data type of the field. */
+ schema: {
+ /** @description The data type of the field. */
+ type: string;
+ /** @description When the data type is an array, the name of the field items within the array. */
+ items?: string;
+ /** @description If the field is a system field, the name of the field. */
+ system?: string;
+ /** @description If the field is a custom field, the URI of the field. */
+ custom?: string;
+ /**
+ * Format: int64
+ * @description If the field is a custom field, the custom ID of the field.
+ */
+ customId?: number;
+ /** @description If the field is a custom field, the configuration of the field. */
+ configuration?: {
+ [key: string]: unknown;
+ };
+ };
+ /** @description The name of the field. */
+ name: string;
+ /** @description The key of the field. */
+ key: string;
+ /** @description The URL that can be used to automatically complete the field. */
+ autoCompleteUrl?: string;
+ /** @description Whether the field has a default value. */
+ hasDefaultValue?: boolean;
+ /** @description The list of operations that can be performed on the field. */
+ operations: readonly string[];
+ /** @description The list of values allowed in the field. */
+ allowedValues?: readonly unknown[];
+ /** @description The default value of the field. */
+ defaultValue?: unknown;
+ /** @description The configuration properties. */
+ configuration?: {
+ [key: string]: unknown;
+ };
+ };
+ };
+ };
+ /** @description The schema of a field. */
+ JsonTypeBean: {
+ /** @description The data type of the field. */
+ type: string;
+ /** @description When the data type is an array, the name of the field items within the array. */
+ items?: string;
+ /** @description If the field is a system field, the name of the field. */
+ system?: string;
+ /** @description If the field is a custom field, the URI of the field. */
+ custom?: string;
+ /**
+ * Format: int64
+ * @description If the field is a custom field, the custom ID of the field.
+ */
+ customId?: number;
+ /** @description If the field is a custom field, the configuration of the field. */
+ configuration?: {
+ [key: string]: unknown;
+ };
+ };
+ /** @description Details a link group, which defines issue operations. */
+ LinkGroup: {
+ id?: string;
+ styleClass?: string;
+ /** @description Details about the operations available in this version. */
+ header?: {
+ id?: string;
+ styleClass?: string;
+ iconClass?: string;
+ label?: string;
+ title?: string;
+ href?: string;
+ /** Format: int32 */
+ weight?: number;
+ };
+ /** Format: int32 */
+ weight?: number;
+ links?: {
+ id?: string;
+ styleClass?: string;
+ iconClass?: string;
+ label?: string;
+ title?: string;
+ href?: string;
+ /** Format: int32 */
+ weight?: number;
+ }[];
+ groups?: components["schemas"]["LinkGroup"][];
+ };
+ /** @description Details of the operations that can be performed on the issue. */
+ Operations: {
+ /** @description Details of the link groups defining issue operations. */
+ linkGroups?: readonly components["schemas"]["LinkGroup"][];
+ [key: string]: unknown;
+ };
+ /** @description A page of changelogs. */
+ PageOfChangelogs: {
+ /**
+ * Format: int32
+ * @description The index of the first item returned on the page.
+ */
+ startAt?: number;
+ /**
+ * Format: int32
+ * @description The maximum number of results that could be on the page.
+ */
+ maxResults?: number;
+ /**
+ * Format: int32
+ * @description The number of results on the page.
+ */
+ total?: number;
+ /** @description The list of changelogs. */
+ histories?: readonly {
+ /** @description The ID of the changelog. */
+ id?: string;
+ /** @description The user who made the change. */
+ author?: {
+ /** @description The URL of the user. */
+ self?: string;
+ /** @description This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. */
+ name?: string;
+ /** @description This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. */
+ key?: string;
+ /** @description The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. */
+ accountId?: string;
+ /** @description The email address of the user. Depending on the user’s privacy settings, this may be returned as null. */
+ emailAddress?: string;
+ /** @description The avatars of the user. */
+ avatarUrls?: {
+ /**
+ * Format: uri
+ * @description The URL of the item's 16x16 pixel avatar.
+ */
+ "16x16"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the item's 24x24 pixel avatar.
+ */
+ "24x24"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the item's 32x32 pixel avatar.
+ */
+ "32x32"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the item's 48x48 pixel avatar.
+ */
+ "48x48"?: string;
+ };
+ /** @description The display name of the user. Depending on the user’s privacy settings, this may return an alternative value. */
+ displayName?: string;
+ /** @description Whether the user is active. */
+ active?: boolean;
+ /** @description The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null. */
+ timeZone?: string;
+ /** @description 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) */
+ accountType?: string;
+ };
+ /**
+ * Format: date-time
+ * @description The date on which the change took place.
+ */
+ created?: string;
+ /** @description The list of items changed. */
+ items?: readonly {
+ /** @description The name of the field changed. */
+ field?: string;
+ /** @description The type of the field changed. */
+ fieldtype?: string;
+ /** @description The ID of the field changed. */
+ fieldId?: string;
+ /** @description The details of the original value. */
+ from?: string;
+ /** @description The details of the original value as a string. */
+ fromString?: string;
+ /** @description The details of the new value. */
+ to?: string;
+ /** @description The details of the new value as a string. */
+ toString?: string;
+ }[];
+ /** @description The history metadata associated with the changed. */
+ historyMetadata?: {
+ /** @description The type of the history record. */
+ type?: string;
+ /** @description The description of the history record. */
+ description?: string;
+ /** @description The description key of the history record. */
+ descriptionKey?: string;
+ /** @description The activity described in the history record. */
+ activityDescription?: string;
+ /** @description The key of the activity described in the history record. */
+ activityDescriptionKey?: string;
+ /** @description The description of the email address associated the history record. */
+ emailDescription?: string;
+ /** @description The description key of the email address associated the history record. */
+ emailDescriptionKey?: string;
+ /** @description Details of the user whose action created the history record. */
+ actor?: {
+ /** @description The ID of the user or system associated with a history record. */
+ id?: string;
+ /** @description The display name of the user or system associated with a history record. */
+ displayName?: string;
+ /** @description The key of the display name of the user or system associated with a history record. */
+ displayNameKey?: string;
+ /** @description The type of the user or system associated with a history record. */
+ type?: string;
+ /** @description The URL to an avatar for the user or system associated with a history record. */
+ avatarUrl?: string;
+ /** @description The URL of the user or system associated with a history record. */
+ url?: string;
+ [key: string]: unknown;
+ };
+ /** @description Details of the system that generated the history record. */
+ generator?: {
+ /** @description The ID of the user or system associated with a history record. */
+ id?: string;
+ /** @description The display name of the user or system associated with a history record. */
+ displayName?: string;
+ /** @description The key of the display name of the user or system associated with a history record. */
+ displayNameKey?: string;
+ /** @description The type of the user or system associated with a history record. */
+ type?: string;
+ /** @description The URL to an avatar for the user or system associated with a history record. */
+ avatarUrl?: string;
+ /** @description The URL of the user or system associated with a history record. */
+ url?: string;
+ [key: string]: unknown;
+ };
+ /** @description Details of the cause that triggered the creation the history record. */
+ cause?: {
+ /** @description The ID of the user or system associated with a history record. */
+ id?: string;
+ /** @description The display name of the user or system associated with a history record. */
+ displayName?: string;
+ /** @description The key of the display name of the user or system associated with a history record. */
+ displayNameKey?: string;
+ /** @description The type of the user or system associated with a history record. */
+ type?: string;
+ /** @description The URL to an avatar for the user or system associated with a history record. */
+ avatarUrl?: string;
+ /** @description The URL of the user or system associated with a history record. */
+ url?: string;
+ [key: string]: unknown;
+ };
+ /** @description Additional arbitrary information about the history record. */
+ extraData?: {
+ [key: string]: string;
+ };
+ [key: string]: unknown;
+ };
+ }[];
+ };
+ /** @description The result of a JQL search. */
+ SearchResults: {
+ /** @description Expand options that include additional search result details in the response. */
+ expand?: string;
+ /**
+ * Format: int32
+ * @description The index of the first item returned on the page.
+ */
+ startAt?: number;
+ /**
+ * Format: int32
+ * @description The maximum number of results that could be on the page.
+ */
+ maxResults?: number;
+ /**
+ * Format: int32
+ * @description The number of results on the page.
+ */
+ total?: number;
+ /** @description The list of issues found by the search. */
+ issues?: readonly components["schemas"]["IssueBean"][];
+ /** @description Any warnings related to the JQL query. */
+ warningMessages?: readonly string[];
+ /** @description The ID and name of each field in the search results. */
+ names?: {
+ [key: string]: string;
+ };
+ /** @description The schema describing the field types in the search results. */
+ schema?: {
+ [key: string]: {
+ /** @description The data type of the field. */
+ type: string;
+ /** @description When the data type is an array, the name of the field items within the array. */
+ items?: string;
+ /** @description If the field is a system field, the name of the field. */
+ system?: string;
+ /** @description If the field is a custom field, the URI of the field. */
+ custom?: string;
+ /**
+ * Format: int64
+ * @description If the field is a custom field, the custom ID of the field.
+ */
+ customId?: number;
+ /** @description If the field is a custom field, the configuration of the field. */
+ configuration?: {
+ [key: string]: unknown;
+ };
+ };
+ };
+ };
+ /** @description Details about the operations available in this version. */
+ SimpleLink: {
+ id?: string;
+ styleClass?: string;
+ iconClass?: string;
+ label?: string;
+ title?: string;
+ href?: string;
+ /** Format: int32 */
+ weight?: number;
+ };
+ /** @description A status category. */
+ StatusCategory: {
+ /** @description The URL of the status category. */
+ self?: string;
+ /**
+ * Format: int64
+ * @description The ID of the status category.
+ */
+ id?: number;
+ /** @description The key of the status category. */
+ key?: string;
+ /** @description The name of the color used to represent the status category. */
+ colorName?: string;
+ /** @description The name of the status category. */
+ name?: string;
+ [key: string]: unknown;
+ };
+ /** @description A status. */
+ StatusDetails: {
+ /** @description The URL of the status. */
+ self?: string;
+ /** @description The description of the status. */
+ description?: string;
+ /** @description The URL of the icon used to represent the status. */
+ iconUrl?: string;
+ /** @description The name of the status. */
+ name?: string;
+ /** @description The ID of the status. */
+ id?: string;
+ /** @description The category assigned to the status. */
+ statusCategory?: {
+ /** @description The URL of the status category. */
+ self?: string;
+ /**
+ * Format: int64
+ * @description The ID of the status category.
+ */
+ id?: number;
+ /** @description The key of the status category. */
+ key?: string;
+ /** @description The name of the color used to represent the status category. */
+ colorName?: string;
+ /** @description The name of the status category. */
+ name?: string;
+ [key: string]: unknown;
+ };
+ [key: string]: unknown;
+ };
+ /**
+ * @description User details permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions:
+ *
+ * * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank).
+ * * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values.
+ * * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values.
+ */
+ UserDetails: {
+ /** @description The URL of the user. */
+ self?: string;
+ /** @description This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. */
+ name?: string;
+ /** @description This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. */
+ key?: string;
+ /** @description The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. */
+ accountId?: string;
+ /** @description The email address of the user. Depending on the user’s privacy settings, this may be returned as null. */
+ emailAddress?: string;
+ /** @description The avatars of the user. */
+ avatarUrls?: {
+ /**
+ * Format: uri
+ * @description The URL of the item's 16x16 pixel avatar.
+ */
+ "16x16"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the item's 24x24 pixel avatar.
+ */
+ "24x24"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the item's 32x32 pixel avatar.
+ */
+ "32x32"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the item's 48x48 pixel avatar.
+ */
+ "48x48"?: string;
+ };
+ /** @description The display name of the user. Depending on the user’s privacy settings, this may return an alternative value. */
+ displayName?: string;
+ /** @description Whether the user is active. */
+ active?: boolean;
+ /** @description The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null. */
+ timeZone?: string;
+ /** @description 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) */
+ accountType?: string;
+ };
+ Entry: {
+ /** Format: int64 */
+ issueId?: number;
+ issueKey?: string;
+ /** Format: int32 */
+ status?: number;
+ errors?: string[];
+ };
+ PartialSuccessBean: {
+ entries?: {
+ /** Format: int64 */
+ issueId?: number;
+ issueKey?: string;
+ /** Format: int32 */
+ status?: number;
+ errors?: string[];
+ }[];
+ };
+ BoardConfigBean: {
+ /** Format: int64 */
+ id?: number;
+ name?: string;
+ type?: string;
+ /** Format: uri */
+ self?: string;
+ location?: {
+ /** @enum {string} */
+ type?: "project" | "user";
+ projectKeyOrId?: string;
+ };
+ filter?: {
+ id?: string;
+ /** Format: uri */
+ self?: string;
+ };
+ subQuery?: {
+ query?: string;
+ };
+ columnConfig?: {
+ columns?: {
+ name?: string;
+ statuses?: {
+ id?: string;
+ /** Format: uri */
+ self?: string;
+ }[];
+ /** Format: int32 */
+ min?: number;
+ /** Format: int32 */
+ max?: number;
+ }[];
+ constraintType?: string;
+ };
+ estimation?: {
+ type?: string;
+ field?: {
+ fieldId?: string;
+ displayName?: string;
+ };
+ };
+ ranking?: {
+ /** Format: int64 */
+ rankCustomFieldId?: number;
+ };
+ };
+ ColumnBean: {
+ name?: string;
+ statuses?: {
+ id?: string;
+ /** Format: uri */
+ self?: string;
+ }[];
+ /** Format: int32 */
+ min?: number;
+ /** Format: int32 */
+ max?: number;
+ };
+ ColumnConfigBean: {
+ columns?: {
+ name?: string;
+ statuses?: {
+ id?: string;
+ /** Format: uri */
+ self?: string;
+ }[];
+ /** Format: int32 */
+ min?: number;
+ /** Format: int32 */
+ max?: number;
+ }[];
+ constraintType?: string;
+ };
+ EstimationConfigBean: {
+ type?: string;
+ field?: {
+ fieldId?: string;
+ displayName?: string;
+ };
+ };
+ EstimationFieldBean: {
+ fieldId?: string;
+ displayName?: string;
+ };
+ LocationBean: {
+ /** @enum {string} */
+ type?: "project" | "user";
+ projectKeyOrId?: string;
+ };
+ RankingConfigBean: {
+ /** Format: int64 */
+ rankCustomFieldId?: number;
+ };
+ RelationBean: {
+ id?: string;
+ /** Format: uri */
+ self?: string;
+ };
+ SubqueryBean: {
+ query?: string;
+ };
+ BoardCreateBean: {
+ name?: string;
+ /** @enum {string} */
+ type?: "kanban" | "scrum" | "agility";
+ /** Format: int64 */
+ filterId?: number;
+ location?: {
+ /** @enum {string} */
+ type?: "project" | "user";
+ projectKeyOrId?: string;
+ };
+ };
+ EstimationConfigurationBean: {
+ /** @enum {string} */
+ value?: "STORY_POINTS" | "ORIGINAL_ESTIMATE";
+ localisedName?: string;
+ localisedDescription?: string;
+ };
+ FeatureBean: {
+ /** @enum {string} */
+ boardFeature?:
+ | "SIMPLE_ROADMAP"
+ | "BACKLOG"
+ | "SPRINTS"
+ | "DEVTOOLS"
+ | "REPORTS"
+ | "ESTIMATION"
+ | "PAGES"
+ | "CODE"
+ | "RELEASES"
+ | "DEPLOYMENTS"
+ | "ISSUE_NAVIGATOR"
+ | "ON_CALL_SCHEDULE"
+ | "BOARD";
+ /** Format: int64 */
+ boardId?: number;
+ /** @enum {string} */
+ state?: "ENABLED" | "DISABLED" | "COMING_SOON";
+ localisedName?: string;
+ localisedDescription?: string;
+ learnMoreLink?: string;
+ imageUri?: string;
+ /** @enum {string} */
+ featureType?: "BASIC" | "ESTIMATION";
+ localisedGroup?: string;
+ permissibleEstimationTypes?: {
+ /** @enum {string} */
+ value?: "STORY_POINTS" | "ORIGINAL_ESTIMATE";
+ localisedName?: string;
+ localisedDescription?: string;
+ }[];
+ featureId?: string;
+ learnMoreArticleId?: string;
+ toggleLocked?: boolean;
+ };
+ FeatureResponseBean: {
+ features?: {
+ /** @enum {string} */
+ boardFeature?:
+ | "SIMPLE_ROADMAP"
+ | "BACKLOG"
+ | "SPRINTS"
+ | "DEVTOOLS"
+ | "REPORTS"
+ | "ESTIMATION"
+ | "PAGES"
+ | "CODE"
+ | "RELEASES"
+ | "DEPLOYMENTS"
+ | "ISSUE_NAVIGATOR"
+ | "ON_CALL_SCHEDULE"
+ | "BOARD";
+ /** Format: int64 */
+ boardId?: number;
+ /** @enum {string} */
+ state?: "ENABLED" | "DISABLED" | "COMING_SOON";
+ localisedName?: string;
+ localisedDescription?: string;
+ learnMoreLink?: string;
+ imageUri?: string;
+ /** @enum {string} */
+ featureType?: "BASIC" | "ESTIMATION";
+ localisedGroup?: string;
+ permissibleEstimationTypes?: {
+ /** @enum {string} */
+ value?: "STORY_POINTS" | "ORIGINAL_ESTIMATE";
+ localisedName?: string;
+ localisedDescription?: string;
+ }[];
+ featureId?: string;
+ learnMoreArticleId?: string;
+ toggleLocked?: boolean;
+ }[];
+ };
+ FeatureToggleRequestBean: {
+ /** Format: int64 */
+ boardId?: number;
+ feature?: string;
+ enabling?: boolean;
+ };
+ FieldEditBean: {
+ value?: string;
+ };
+ };
+ responses: never;
+ parameters: never;
+ requestBodies: never;
+ headers: never;
+ pathItems: never;
+}
+
+export type $defs = Record;
+
+export type external = Record;
+
+export interface operations {
+ /**
+ * Move issues to backlog
+ * @description Move issues to the backlog.
+ * This operation is equivalent to remove future and active sprints from a given set of issues. At most 50 issues may be moved at once.
+ */
+ moveIssuesToBacklog: {
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "issues": [
+ * "PR-1",moveIssuesToBacklog
+ * "10001",
+ * "PR-3"
+ * ]
+ * }
+ */
+ "application/json": {
+ issues?: string[];
+ };
+ };
+ };
+ responses: {
+ /** @description Empty response is returned if operation was successful. */
+ 204: {
+ content: never;
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if user does not a have valid license or does not have permission to assign issues. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if sprint does not exist or the user cannot view it. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Move issues to backlog for board
+ * @description Move issues to the backlog of a particular board (if they are already on that board).
+ * This operation is equivalent to remove future and active sprints from a given set of issues if the board has sprints If the board does not have sprints this will put the issues back into the backlog from the board. At most 50 issues may be moved at once.
+ */
+ moveIssuesToBacklogForBoard: {
+ parameters: {
+ path: {
+ boardId: number;
+ };
+ };
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "rankBeforeIssue": "PR-4",
+ * "rankCustomFieldId": 10521,
+ * "issues": [
+ * "PR-1",
+ * "10001",
+ * "PR-3"
+ * ]
+ * }
+ */
+ "application/json": {
+ issues?: string[];
+ rankBeforeIssue?: string;
+ rankAfterIssue?: string;
+ /** Format: int64 */
+ rankCustomFieldId?: number;
+ };
+ };
+ };
+ responses: {
+ /** @description Empty response is returned if operation was successful. */
+ 204: {
+ content: never;
+ };
+ /** @description Returns the list of issue with status of rank operation. */
+ 207: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if user does not a have valid license or does not have permission to assign issues. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if sprint does not exist or the user cannot view it. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get all boards
+ * @description Returns all boards. This only includes boards that the user has permission to view.
+ *
+ * **Deprecation notice:** The required OAuth 2.0 scopes will be updated on February 15, 2024.
+ *
+ * * `read:board-scope:jira-software`, `read:project:jira`
+ */
+ getAllBoards: {
+ parameters: {
+ query?: {
+ /** @description The starting index of the returned boards. Base index: 0. See the 'Pagination' section at the top of this page for more details. */
+ startAt?: number;
+ /** @description The maximum number of boards to return per page. See the 'Pagination' section at the top of this page for more details. */
+ maxResults?: number;
+ /** @description Filters results to boards of the specified types. Valid values: scrum, kanban, simple. */
+ type?: Record;
+ /** @description Filters results to boards that match or partially match the specified name. */
+ name?: string;
+ /** @description Filters results to boards that are relevant to a project. Relevance means that the jql filter defined in board contains a reference to a project. */
+ projectKeyOrId?: string;
+ accountIdLocation?: string;
+ projectLocation?: string;
+ /** @description Appends private boards to the end of the list. The name and type fields are excluded for security reasons. */
+ includePrivate?: boolean;
+ /** @description If set to true, negate filters used for querying by location. By default false. */
+ negateLocationFiltering?: boolean;
+ /** @description Ordering of the results by a given field. If not provided, values will not be sorted. Valid values: name. */
+ orderBy?: "name" | "-name" | "+name";
+ /** @description List of fields to expand for each board. Valid values: admins, permissions. */
+ expand?: string;
+ /** @description Filters results to boards that are relevant to a filter. Not supported for next-gen boards. */
+ filterId?: number;
+ };
+ };
+ responses: {
+ /** @description Returns the requested boards, at the specified page of the results. */
+ 200: {
+ content: {
+ "application/json": {
+ /** Format: int32 */
+ maxResults?: number;
+ /** Format: int64 */
+ startAt?: number;
+ /** Format: int64 */
+ total?: number;
+ isLast?: boolean;
+ values?: {
+ /**
+ * Format: int64
+ * @description The ID of the board.
+ */
+ id?: number;
+ /**
+ * Format: uri
+ * @description The URL of the board.
+ */
+ self?: string;
+ /** @description The name of the board. */
+ name?: string;
+ /** @description The type the board. */
+ type?: string;
+ admins?: {
+ users?: {
+ /**
+ * @description This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
+ * The key of the user.
+ */
+ key?: string;
+ /**
+ * Format: uri
+ * @description The URL of the user.
+ */
+ self?: string;
+ /**
+ * @description This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
+ * The username of the user.
+ */
+ name?: string;
+ /** @description The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. */
+ displayName?: string;
+ /** @description Whether the user is active. */
+ active?: boolean;
+ /** @description The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. */
+ accountId?: string;
+ /** @description The avatars of the user. */
+ avatarUrls?: {
+ /**
+ * Format: uri
+ * @description The URL of the user's 24x24 pixel avatar.
+ */
+ "24x24"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the user's 32x32 pixel avatar.
+ */
+ "32x32"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the user's 48x48 pixel avatar.
+ */
+ "48x48"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the user's 16x16 pixel avatar.
+ */
+ "16x16"?: string;
+ };
+ }[];
+ groups?: {
+ name?: string;
+ /** Format: uri */
+ self?: string;
+ }[];
+ };
+ /** @description The container that the board is located in. */
+ location?: {
+ /** Format: int64 */
+ projectId?: number;
+ /** Format: int64 */
+ userId?: number;
+ userAccountId?: string;
+ displayName?: string;
+ projectName?: string;
+ projectKey?: string;
+ projectTypeKey?: string;
+ /** Format: uri */
+ avatarURI?: string;
+ name?: string;
+ };
+ /** @description Whether the board can be edited. */
+ canEdit?: boolean;
+ /** @description Whether the board is private. */
+ isPrivate?: boolean;
+ /** @description Whether the board is selected as a favorite. */
+ favourite?: boolean;
+ }[];
+ };
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have valid license. */
+ 403: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Create board
+ * @description Creates a new board. Board name, type and filter ID is required.
+ *
+ * * `name` \- Must be less than 255 characters.
+ * * `type` \- Valid values: scrum, kanban
+ * * `filterId` \- ID of a filter that the user has permissions to view. Note, if the user does not have the 'Create shared objects' permission and tries to create a shared board, a private board will be created instead (remember that board sharing depends on the filter sharing).
+ * * `location` \- The container that the board will be located in. `location` must include the `type` property (Valid values: project, user). If choosing 'project', then a project must be specified by a `projectKeyOrId` property in `location`. If choosing 'user', the current user is chosen by default. The `projectKeyOrId` property should not be provided.
+ *
+ * Note:
+ *
+ * * If you want to create a new project with an associated board, use the [Jira platform REST API](https://docs.atlassian.com/jira/REST/latest). For more information, see the [Create project](#api-rest-api-3-project-post) method. The `projectTypeKey` for software boards must be 'software' and the `projectTemplateKey` must be either `com.pyxis.greenhopper.jira:gh-kanban-template` or `com.pyxis.greenhopper.jira:gh-scrum-template`.
+ * * You can create a filter using the [Jira REST API](https://docs.atlassian.com/jira/REST/latest). For more information, see the [Create filter](#api-rest-api-3-filter-post) method.
+ * * If you do not ORDER BY the Rank field for the filter of your board, you will not be able to reorder issues on the board.
+ */
+ createBoard: {
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "filterId": 10040,
+ * "name": "scrum board",
+ * "location": {
+ * "projectKeyOrId": "10000",
+ * "type": "project"
+ * },
+ * "type": "scrum"
+ * }
+ */
+ "application/json": {
+ name?: string;
+ /** @enum {string} */
+ type?: "kanban" | "scrum" | "agility";
+ /** Format: int64 */
+ filterId?: number;
+ location?: {
+ /** @enum {string} */
+ type?: "project" | "user";
+ projectKeyOrId?: string;
+ };
+ };
+ };
+ };
+ responses: {
+ /** @description Returns the created board. */
+ 201: {
+ content: {
+ "application/json": {
+ /**
+ * Format: int64
+ * @description The ID of the board.
+ */
+ id?: number;
+ /**
+ * Format: uri
+ * @description The URL of the board.
+ */
+ self?: string;
+ /** @description The name of the board. */
+ name?: string;
+ /** @description The type the board. */
+ type?: string;
+ admins?: {
+ users?: {
+ /**
+ * @description This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
+ * The key of the user.
+ */
+ key?: string;
+ /**
+ * Format: uri
+ * @description The URL of the user.
+ */
+ self?: string;
+ /**
+ * @description This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
+ * The username of the user.
+ */
+ name?: string;
+ /** @description The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. */
+ displayName?: string;
+ /** @description Whether the user is active. */
+ active?: boolean;
+ /** @description The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. */
+ accountId?: string;
+ /** @description The avatars of the user. */
+ avatarUrls?: {
+ /**
+ * Format: uri
+ * @description The URL of the user's 24x24 pixel avatar.
+ */
+ "24x24"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the user's 32x32 pixel avatar.
+ */
+ "32x32"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the user's 48x48 pixel avatar.
+ */
+ "48x48"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the user's 16x16 pixel avatar.
+ */
+ "16x16"?: string;
+ };
+ }[];
+ groups?: {
+ name?: string;
+ /** Format: uri */
+ self?: string;
+ }[];
+ };
+ /** @description The container that the board is located in. */
+ location?: {
+ /** Format: int64 */
+ projectId?: number;
+ /** Format: int64 */
+ userId?: number;
+ userAccountId?: string;
+ displayName?: string;
+ projectName?: string;
+ projectKey?: string;
+ projectTypeKey?: string;
+ /** Format: uri */
+ avatarURI?: string;
+ name?: string;
+ };
+ /** @description Whether the board can be edited. */
+ canEdit?: boolean;
+ /** @description Whether the board is private. */
+ isPrivate?: boolean;
+ /** @description Whether the board is selected as a favorite. */
+ favourite?: boolean;
+ };
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not a have valid license. */
+ 403: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get board by filter id
+ * @description Returns any boards which use the provided filter id. This method can be executed by users without a valid software license in order to find which boards are using a particular filter.
+ */
+ getBoardByFilterId: {
+ parameters: {
+ query?: {
+ /** @description The starting index of the returned boards. Base index: 0. See the 'Pagination' section at the top of this page for more details. */
+ startAt?: number;
+ /** @description The maximum number of boards to return per page. Default: 50. See the 'Pagination' section at the top of this page for more details. */
+ maxResults?: number;
+ };
+ path: {
+ /** @description Filters results to boards that are relevant to a filter. Not supported for next-gen boards. */
+ filterId: number;
+ };
+ };
+ responses: {
+ /** @description Returns the requested boards, at the specified page of the results. */
+ 200: {
+ content: {
+ "application/json": {
+ /** Format: int32 */
+ maxResults?: number;
+ /** Format: int64 */
+ startAt?: number;
+ /** Format: int64 */
+ total?: number;
+ isLast?: boolean;
+ values?: {
+ /** Format: int64 */
+ id?: number;
+ /** Format: uri */
+ self?: string;
+ name?: string;
+ }[];
+ };
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get board
+ * @description Returns the board for the given board ID. This board will only be returned if the user has permission to view it. Admins without the view permission will see the board as a private one, so will see only a subset of the board's data (board location for instance).
+ */
+ getBoard: {
+ parameters: {
+ path: {
+ /** @description The ID of the requested board. */
+ boardId: number;
+ };
+ };
+ responses: {
+ /** @description Returns the requested board. */
+ 200: {
+ content: {
+ "application/json": {
+ /**
+ * Format: int64
+ * @description The ID of the board.
+ */
+ id?: number;
+ /**
+ * Format: uri
+ * @description The URL of the board.
+ */
+ self?: string;
+ /** @description The name of the board. */
+ name?: string;
+ /** @description The type the board. */
+ type?: string;
+ admins?: {
+ users?: {
+ /**
+ * @description This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
+ * The key of the user.
+ */
+ key?: string;
+ /**
+ * Format: uri
+ * @description The URL of the user.
+ */
+ self?: string;
+ /**
+ * @description This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
+ * The username of the user.
+ */
+ name?: string;
+ /** @description The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. */
+ displayName?: string;
+ /** @description Whether the user is active. */
+ active?: boolean;
+ /** @description The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. */
+ accountId?: string;
+ /** @description The avatars of the user. */
+ avatarUrls?: {
+ /**
+ * Format: uri
+ * @description The URL of the user's 24x24 pixel avatar.
+ */
+ "24x24"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the user's 32x32 pixel avatar.
+ */
+ "32x32"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the user's 48x48 pixel avatar.
+ */
+ "48x48"?: string;
+ /**
+ * Format: uri
+ * @description The URL of the user's 16x16 pixel avatar.
+ */
+ "16x16"?: string;
+ };
+ }[];
+ groups?: {
+ name?: string;
+ /** Format: uri */
+ self?: string;
+ }[];
+ };
+ /** @description The container that the board is located in. */
+ location?: {
+ /** Format: int64 */
+ projectId?: number;
+ /** Format: int64 */
+ userId?: number;
+ userAccountId?: string;
+ displayName?: string;
+ projectName?: string;
+ projectKey?: string;
+ projectTypeKey?: string;
+ /** Format: uri */
+ avatarURI?: string;
+ name?: string;
+ };
+ /** @description Whether the board can be edited. */
+ canEdit?: boolean;
+ /** @description Whether the board is private. */
+ isPrivate?: boolean;
+ /** @description Whether the board is selected as a favorite. */
+ favourite?: boolean;
+ };
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not a have valid license. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the board does not exist or the user does not have permission to view it. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Delete board
+ * @description Deletes the board. Admin without the view permission can still remove the board.
+ */
+ deleteBoard: {
+ parameters: {
+ path: {
+ /** @description ID of the board to be deleted */
+ boardId: number;
+ };
+ };
+ responses: {
+ /** @description Returned if the board has been successfully removed. */
+ 204: {
+ content: never;
+ };
+ /** @description Returned if the user does not a have valid license, or when the user does not have the permission to delete the board, or when the user tried to delete a next-gen board. The user has to be a Jira Administrator or a board administrator to remove the board. Next-gen boards cannot be deleted, because next-gen software projects must have a board. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if a board with the given ID does not exist or the user does not have the permission to view the board. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get issues for backlog
+ * @description Returns all issues from the board's backlog, for the given board ID. This only includes issues that the user has permission to view. The backlog contains incomplete issues that are not assigned to any future or active sprint. Note, if the user does not have permission to view the board, no issues will be returned at all. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank.
+ */
+ getIssuesForBacklog: {
+ parameters: {
+ query?: {
+ /** @description The starting index of the returned issues. Base index: 0. See the 'Pagination' section at the top of this page for more details. */
+ startAt?: number;
+ /** @description The maximum number of issues to return per page. Default: 50. See the 'Pagination' section at the top of this page for more details. Note, the total number of issues returned is limited by the property 'jira.search.views.default.max' in your Jira instance. If you exceed this limit, your results will be truncated. */
+ maxResults?: number;
+ /**
+ * @description Filters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues.
+ * Note that `username` and `userkey` can't be used as search terms for this parameter due to privacy reasons. Use `accountId` instead.
+ */
+ jql?: string;
+ /** @description Specifies whether to validate the JQL query or not. Default: true. */
+ validateQuery?: boolean;
+ /** @description The list of fields to return for each issue. By default, all navigable and Agile fields are returned. */
+ fields?: Record[];
+ /** @description This parameter is currently not used. */
+ expand?: string;
+ };
+ path: {
+ /** @description The ID of the board that has the backlog containing the requested issues. */
+ boardId: number;
+ };
+ };
+ responses: {
+ /** @description Returns the requested issues, at the specified page of the results. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["SearchResults"];
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not a have valid license. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the board does not exist or the user does not have permission to view it. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get configuration
+ * @description Get the board configuration. The response contains the following fields:
+ *
+ * * `id` \- ID of the board.
+ * * `name` \- Name of the board.
+ * * `filter` \- Reference to the filter used by the given board.
+ * * `location` \- Reference to the container that the board is located in. Includes the container type (Valid values: project, user).
+ * * `subQuery` (Kanban only) - JQL subquery used by the given board.
+ * * `columnConfig` \- The column configuration lists the columns for the board, in the order defined in the column configuration. For each column, it shows the issue status mapping as well as the constraint type (Valid values: none, issueCount, issueCountExclSubs) for the min/max number of issues. Note, the last column with statuses mapped to it is treated as the "Done" column, which means that issues in that column will be marked as already completed.
+ * * `estimation` (Scrum only) - Contains information about type of estimation used for the board. Valid values: none, issueCount, field. If the estimation type is "field", the ID and display name of the field used for estimation is also returned. Note, estimates for an issue can be updated by a PUT /rest/api/3/issue/\{issueIdOrKey\} request, however the fields must be on the screen. "timeoriginalestimate" field will never be on the screen, so in order to update it "originalEstimate" in "timetracking" field should be updated.
+ * * `ranking` \- Contains information about custom field used for ranking in the given board.
+ */
+ getConfiguration: {
+ parameters: {
+ path: {
+ /** @description The ID of the board for which configuration is requested. */
+ boardId: number;
+ };
+ };
+ responses: {
+ /** @description Returns the configuration of the board for given boardId. */
+ 200: {
+ content: {
+ "application/json": {
+ /** Format: int64 */
+ id?: number;
+ name?: string;
+ type?: string;
+ /** Format: uri */
+ self?: string;
+ location?: {
+ /** @enum {string} */
+ type?: "project" | "user";
+ projectKeyOrId?: string;
+ };
+ filter?: {
+ id?: string;
+ /** Format: uri */
+ self?: string;
+ };
+ subQuery?: {
+ query?: string;
+ };
+ columnConfig?: {
+ columns?: {
+ name?: string;
+ statuses?: {
+ id?: string;
+ /** Format: uri */
+ self?: string;
+ }[];
+ /** Format: int32 */
+ min?: number;
+ /** Format: int32 */
+ max?: number;
+ }[];
+ constraintType?: string;
+ };
+ estimation?: {
+ type?: string;
+ field?: {
+ fieldId?: string;
+ displayName?: string;
+ };
+ };
+ ranking?: {
+ /** Format: int64 */
+ rankCustomFieldId?: number;
+ };
+ };
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if user does not a have valid license. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if board does not exist or the user cannot view it. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get epics
+ * @description Returns all epics from the board, for the given board ID. This only includes epics that the user has permission to view. Note, if the user does not have permission to view the board, no epics will be returned at all.
+ */
+ getEpics: {
+ parameters: {
+ query?: {
+ /** @description The starting index of the returned epics. Base index: 0. See the 'Pagination' section at the top of this page for more details. */
+ startAt?: number;
+ /** @description The maximum number of epics to return per page. See the 'Pagination' section at the top of this page for more details. */
+ maxResults?: number;
+ /** @description Filters results to epics that are either done or not done. Valid values: true, false. */
+ done?: string;
+ };
+ path: {
+ /** @description The ID of the board that contains the requested epics. */
+ boardId: number;
+ };
+ };
+ responses: {
+ /** @description Returns the requested epics, at the specified page of the results. */
+ 200: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not have valid license. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if board does not exist or the user does not have permission to view it. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get issues without epic for board
+ * @description Returns all issues that do not belong to any epic on a board, for a given board ID. This only includes issues that the user has permission to view. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank.
+ */
+ getIssuesWithoutEpicForBoard: {
+ parameters: {
+ query?: {
+ /** @description The starting index of the returned issues. Base index: 0. See the 'Pagination' section at the top of this page for more details. */
+ startAt?: number;
+ /** @description The maximum number of issues to return per page. See the 'Pagination' section at the top of this page for more details. Note, the total number of issues returned is limited by the property 'jira.search.views.default.max' in your Jira instance. If you exceed this limit, your results will be truncated. */
+ maxResults?: number;
+ /**
+ * @description Filters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues.
+ * Note that `username` and `userkey` can't be used as search terms for this parameter due to privacy reasons. Use `accountId` instead.
+ */
+ jql?: string;
+ /** @description Specifies whether to validate the JQL query or not. Default: true. */
+ validateQuery?: boolean;
+ /** @description The list of fields to return for each issue. By default, all navigable and Agile fields are returned. */
+ fields?: Record[];
+ /** @description A comma-separated list of the parameters to expand. */
+ expand?: string;
+ };
+ path: {
+ /** @description The ID of the board that contains the requested issues. */
+ boardId: number;
+ };
+ };
+ responses: {
+ /** @description Returns the requested issues, at the specified page of the results. */
+ 200: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not a have valid license. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the board does not exist or the user does not have permission to view it. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get board issues for epic
+ * @description Returns all issues that belong to an epic on the board, for the given epic ID and the board ID. This only includes issues that the user has permission to view. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank.
+ */
+ getBoardIssuesForEpic: {
+ parameters: {
+ query?: {
+ /** @description The starting index of the returned issues. Base index: 0. See the 'Pagination' section at the top of this page for more details. */
+ startAt?: number;
+ /** @description The maximum number of issues to return per page. Default: 50. See the 'Pagination' section at the top of this page for more details. Note, the total number of issues returned is limited by the property 'jira.search.views.default.max' in your Jira instance. If you exceed this limit, your results will be truncated. */
+ maxResults?: number;
+ /** @description Filters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues. */
+ jql?: string;
+ /** @description Specifies whether to validate the JQL query or not. Default: true. */
+ validateQuery?: boolean;
+ /** @description The list of fields to return for each issue. By default, all navigable and Agile fields are returned. */
+ fields?: Record[];
+ /** @description A comma-separated list of the parameters to expand. */
+ expand?: string;
+ };
+ path: {
+ /** @description The ID of the board that contains the requested issues. */
+ boardId: number;
+ /** @description The ID of the epic that contains the requested issues. */
+ epicId: number;
+ };
+ };
+ responses: {
+ /** @description Returns the requested issues, at the specified page of the results. */
+ 200: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not a have valid license. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the board does not exist or the user does not have permission to view it. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /** Get features for board */
+ getFeaturesForBoard: {
+ parameters: {
+ path: {
+ boardId: number;
+ };
+ };
+ responses: {
+ /** @description 200 response */
+ 200: {
+ content: {
+ "application/json": {
+ features?: {
+ /** @enum {string} */
+ boardFeature?:
+ | "SIMPLE_ROADMAP"
+ | "BACKLOG"
+ | "SPRINTS"
+ | "DEVTOOLS"
+ | "REPORTS"
+ | "ESTIMATION"
+ | "PAGES"
+ | "CODE"
+ | "RELEASES"
+ | "DEPLOYMENTS"
+ | "ISSUE_NAVIGATOR"
+ | "ON_CALL_SCHEDULE"
+ | "BOARD";
+ /** Format: int64 */
+ boardId?: number;
+ /** @enum {string} */
+ state?: "ENABLED" | "DISABLED" | "COMING_SOON";
+ localisedName?: string;
+ localisedDescription?: string;
+ learnMoreLink?: string;
+ imageUri?: string;
+ /** @enum {string} */
+ featureType?: "BASIC" | "ESTIMATION";
+ localisedGroup?: string;
+ permissibleEstimationTypes?: {
+ /** @enum {string} */
+ value?: "STORY_POINTS" | "ORIGINAL_ESTIMATE";
+ localisedName?: string;
+ localisedDescription?: string;
+ }[];
+ featureId?: string;
+ learnMoreArticleId?: string;
+ toggleLocked?: boolean;
+ }[];
+ };
+ };
+ };
+ };
+ };
+ /** Toggle features */
+ toggleFeatures: {
+ parameters: {
+ path: {
+ boardId: number;
+ };
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** Format: int64 */
+ boardId?: number;
+ feature?: string;
+ enabling?: boolean;
+ };
+ };
+ };
+ responses: {
+ /** @description 200 response */
+ 200: {
+ content: {
+ "application/json": {
+ features?: {
+ /** @enum {string} */
+ boardFeature?:
+ | "SIMPLE_ROADMAP"
+ | "BACKLOG"
+ | "SPRINTS"
+ | "DEVTOOLS"
+ | "REPORTS"
+ | "ESTIMATION"
+ | "PAGES"
+ | "CODE"
+ | "RELEASES"
+ | "DEPLOYMENTS"
+ | "ISSUE_NAVIGATOR"
+ | "ON_CALL_SCHEDULE"
+ | "BOARD";
+ /** Format: int64 */
+ boardId?: number;
+ /** @enum {string} */
+ state?: "ENABLED" | "DISABLED" | "COMING_SOON";
+ localisedName?: string;
+ localisedDescription?: string;
+ learnMoreLink?: string;
+ imageUri?: string;
+ /** @enum {string} */
+ featureType?: "BASIC" | "ESTIMATION";
+ localisedGroup?: string;
+ permissibleEstimationTypes?: {
+ /** @enum {string} */
+ value?: "STORY_POINTS" | "ORIGINAL_ESTIMATE";
+ localisedName?: string;
+ localisedDescription?: string;
+ }[];
+ featureId?: string;
+ learnMoreArticleId?: string;
+ toggleLocked?: boolean;
+ }[];
+ };
+ };
+ };
+ };
+ };
+ /**
+ * Get issues for board
+ * @description Returns all issues from a board, for a given board ID. This only includes issues that the user has permission to view. An issue belongs to the board if its status is mapped to the board's column. Epic issues do not belongs to the scrum boards. Note, if the user does not have permission to view the board, no issues will be returned at all. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank.
+ */
+ getIssuesForBoard: {
+ parameters: {
+ query?: {
+ /** @description The starting index of the returned issues. Base index: 0. See the 'Pagination' section at the top of this page for more details. */
+ startAt?: number;
+ /** @description The maximum number of issues to return per page. See the 'Pagination' section at the top of this page for more details. Note, the total number of issues returned is limited by the property 'jira.search.views.default.max' in your Jira instance. If you exceed this limit, your results will be truncated. */
+ maxResults?: number;
+ /**
+ * @description Filters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues.
+ * Note that `username` and `userkey` can't be used as search terms for this parameter due to privacy reasons. Use `accountId` instead.
+ */
+ jql?: string;
+ /** @description Specifies whether to validate the JQL query or not. Default: true. */
+ validateQuery?: boolean;
+ /** @description The list of fields to return for each issue. By default, all navigable and Agile fields are returned. */
+ fields?: Record[];
+ /** @description This parameter is currently not used. */
+ expand?: string;
+ };
+ path: {
+ /** @description The ID of the board that contains the requested issues. */
+ boardId: number;
+ };
+ };
+ responses: {
+ /** @description Returns the requested issues, at the specified page of the results. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["SearchResults"];
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not a have valid license. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the board does not exist or the user does not have permission to view it. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Move issues to board
+ * @description Move issues from the backog to the board (if they are already in the backlog of that board).
+ * This operation either moves an issue(s) onto a board from the backlog (by adding it to the issueList for the board) Or transitions the issue(s) to the first column for a kanban board with backlog. At most 50 issues may be moved at once.
+ */
+ moveIssuesToBoard: {
+ parameters: {
+ path: {
+ boardId: number;
+ };
+ };
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "rankBeforeIssue": "PR-4",
+ * "rankCustomFieldId": 10521,
+ * "issues": [
+ * "PR-1",
+ * "10001",
+ * "PR-3"
+ * ]
+ * }
+ */
+ "application/json": {
+ issues?: string[];
+ rankBeforeIssue?: string;
+ rankAfterIssue?: string;
+ /** Format: int64 */
+ rankCustomFieldId?: number;
+ };
+ };
+ };
+ responses: {
+ /** @description Empty response is returned if operation was successful. */
+ 204: {
+ content: never;
+ };
+ /** @description Returns the list of issue with status of rank operation. */
+ 207: {
+ content: {
+ "application/json": {
+ entries?: {
+ /** Format: int64 */
+ issueId?: number;
+ issueKey?: string;
+ /** Format: int32 */
+ status?: number;
+ errors?: string[];
+ }[];
+ };
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if user does not a have valid license or does not have permission to assign issues. */
+ 403: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get projects
+ * @description Returns all projects that are associated with the board, for the given board ID. If the user does not have permission to view the board, no projects will be returned at all. Returned projects are ordered by the name.
+ *
+ * A project is associated with a board if the board filter contains reference the project or there is an issue from the project that belongs to the board.
+ *
+ * The board filter contains reference the project only if JQL query guarantees that returned issues will be returned from the project set defined in JQL. For instance the query `project in (ABC, BCD) AND reporter = admin` have reference to ABC and BCD projects but query `project in (ABC, BCD) OR reporter = admin` doesn't have reference to any project.
+ *
+ * An issue belongs to the board if its status is mapped to the board's column. Epic issues do not belongs to the scrum boards.
+ */
+ getProjects: {
+ parameters: {
+ query?: {
+ /** @description The starting index of the returned projects. Base index: 0. See the 'Pagination' section at the top of this page for more details. */
+ startAt?: number;
+ /** @description The maximum number of projects to return per page. See the 'Pagination' section at the top of this page for more details. */
+ maxResults?: number;
+ };
+ path: {
+ /** @description The ID of the board that contains returned projects. */
+ boardId: number;
+ };
+ };
+ responses: {
+ /** @description Returns the board's projects, at the specified page of the results. */
+ 200: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not a have valid license. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if board does not exist or the user does not have permission to access it. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get projects full
+ * @description Returns all projects that are statically associated with the board, for the given board ID. Returned projects are ordered by the name.
+ *
+ * A project is associated with a board if the board filter contains reference the project.
+ *
+ * The board filter contains reference the project only if JQL query guarantees that returned issues will be returned from the project set defined in JQL. For instance the query `project in (ABC, BCD) AND reporter = admin` have reference to ABC and BCD projects but query `project in (ABC, BCD) OR reporter = admin` doesn't have reference to any project.
+ */
+ getProjectsFull: {
+ parameters: {
+ path: {
+ /** @description The ID of the board that contains returned projects. */
+ boardId: number;
+ };
+ };
+ responses: {
+ /** @description Returns the board's projects, at the specified page of the results. */
+ 200: {
+ content: never;
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not a have valid license. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if board does not exist or the user does not have permission to access it. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get board property keys
+ * @description Returns the keys of all properties for the board identified by the id. The user who retrieves the property keys is required to have permissions to view the board.
+ */
+ getBoardPropertyKeys: {
+ parameters: {
+ path: {
+ /** @description the ID of the board from which property keys will be returned. */
+ boardId: string;
+ };
+ };
+ responses: {
+ /** @description Returned if the board with given id exists. */
+ 200: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the boardId is invalid (negative or not a number). */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the calling user is not authenticated. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the board with given id does not exist, or if the property with given key is not found, or the user doesn't have permissions to see it. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get board property
+ * @description Returns the value of the property with a given key from the board identified by the provided id. The user who retrieves the property is required to have permissions to view the board.
+ */
+ getBoardProperty: {
+ parameters: {
+ path: {
+ /** @description the ID of the board from which the property will be returned. */
+ boardId: string;
+ /** @description the key of the property to return. */
+ propertyKey: string;
+ };
+ };
+ responses: {
+ /** @description Returned if the board exists and the property was found. */
+ 200: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the boardId is invalid (negative or not a number). */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the calling user is not authenticated. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the board with given id does not exist, or if the property with given key is not found, or the user doesn't have permissions to see it. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Set board property
+ * @description Sets the value of the specified board's property.
+ *
+ * You can use this resource to store a custom data against the board identified by the id. The user who stores the data is required to have permissions to modify the board.
+ */
+ setBoardProperty: {
+ parameters: {
+ path: {
+ /** @description the ID of the board on which the property will be set. */
+ boardId: string;
+ /** @description the key of the board's property. The maximum length of the key is 255 bytes. */
+ propertyKey: string;
+ };
+ };
+ responses: {
+ /** @description Returned if the board property is successfully updated. */
+ 200: {
+ content: never;
+ };
+ /** @description Returned if the board property is successfully created. */
+ 201: {
+ content: never;
+ };
+ /** @description Returned if the boardId is invalid (negative or not a number). */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the calling user is not authenticated. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the board with given id does not exist or the user doesn't have permissions to see it. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Delete board property
+ * @description Removes the property from the board identified by the id. Ths user removing the property is required to have permissions to modify the board.
+ */
+ deleteBoardProperty: {
+ parameters: {
+ path: {
+ /** @description the id of the board from which the property will be removed. */
+ boardId: string;
+ /** @description the key of the property to remove. */
+ propertyKey: string;
+ };
+ };
+ responses: {
+ /** @description Returned if the board property was removed successfully. */
+ 204: {
+ content: never;
+ };
+ /** @description Returned if the boardId is invalid (negative or not a number). */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the calling user is not authenticated. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the board with given id does not exist, or if the property with given key is not found, or the user doesn't have permissions to see it. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get all quick filters
+ * @description Returns all quick filters from a board, for a given board ID.
+ */
+ getAllQuickFilters: {
+ parameters: {
+ query?: {
+ /** @description The starting index of the returned quick filters. Base index: 0. See the 'Pagination' section at the top of this page for more details. */
+ startAt?: number;
+ /** @description The maximum number of sprints to return per page. See the 'Pagination' section at the top of this page for more details. */
+ maxResults?: number;
+ };
+ path: {
+ /** @description The ID of the board that contains the requested quick filters. */
+ boardId: number;
+ };
+ };
+ responses: {
+ /** @description Returns the requested quick filters, at the specified page of the results. Quick filters will be ordered first by position. */
+ 200: {
+ content: {
+ "application/json": {
+ /** Format: int32 */
+ maxResults?: number;
+ /** Format: int64 */
+ startAt?: number;
+ /** Format: int64 */
+ total?: number;
+ isLast?: boolean;
+ values?: {
+ /** Format: int64 */
+ id?: number;
+ /** Format: int64 */
+ boardId?: number;
+ name?: string;
+ jql?: string;
+ description?: string;
+ /** Format: int32 */
+ position?: number;
+ }[];
+ };
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not a have valid license. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if board does not exist or the user does not have permission to view it. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get quick filter
+ * @description Returns the quick filter for a given quick filter ID. The quick filter will only be returned if the user can view the board that the quick filter belongs to.
+ */
+ getQuickFilter: {
+ parameters: {
+ path: {
+ boardId: number;
+ /** @description The ID of the requested quick filter. */
+ quickFilterId: number;
+ };
+ };
+ responses: {
+ /** @description Returns the requested quick filter. */
+ 200: {
+ content: {
+ "application/json": {
+ /** Format: int64 */
+ id?: number;
+ /** Format: int64 */
+ boardId?: number;
+ name?: string;
+ jql?: string;
+ description?: string;
+ /** Format: int32 */
+ position?: number;
+ };
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not a have valid license. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the board with given id does not exist or if the quick filter with given id is not found or the user doesn't have permissions to see it. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /** Get reports for board */
+ getReportsForBoard: {
+ parameters: {
+ path: {
+ boardId: number;
+ };
+ };
+ responses: {
+ /** @description 200 response */
+ 200: {
+ content: {
+ "application/json": {
+ reports?: Record[];
+ };
+ };
+ };
+ };
+ };
+ /**
+ * Get all sprints
+ * @description Returns all sprints from a board, for a given board ID. This only includes sprints that the user has permission to view.
+ */
+ getAllSprints: {
+ parameters: {
+ query?: {
+ /** @description The starting index of the returned sprints. Base index: 0. See the 'Pagination' section at the top of this page for more details. */
+ startAt?: number;
+ /** @description The maximum number of sprints to return per page. See the 'Pagination' section at the top of this page for more details. */
+ maxResults?: number;
+ /** @description Filters results to sprints in specified states. Valid values: future, active, closed. You can define multiple states separated by commas, e.g. state=active,closed */
+ state?: Record;
+ };
+ path: {
+ /** @description The ID of the board that contains the requested sprints. */
+ boardId: number;
+ };
+ };
+ responses: {
+ /** @description Returns the requested sprints, at the specified page of the results. Sprints will be ordered first by state (i.e. closed, active, future) then by their position in the backlog. */
+ 200: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not a have valid license. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if board does not exist or the user does not have permission to view it. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get board issues for sprint
+ * @description Get all issues you have access to that belong to the sprint from the board. Issue returned from this resource contains additional fields like: sprint, closedSprints, flagged and epic. Issues are returned ordered by rank. JQL order has higher priority than default rank.
+ */
+ getBoardIssuesForSprint: {
+ parameters: {
+ query?: {
+ /** @description The starting index of the returned issues. Base index: 0. See the 'Pagination' section at the top of this page for more details. */
+ startAt?: number;
+ /** @description The maximum number of issues to return per page. See the 'Pagination' section at the top of this page for more details. Note, the total number of issues returned is limited by the property 'jira.search.views.default.max' in your Jira instance. If you exceed this limit, your results will be truncated. */
+ maxResults?: number;
+ /**
+ * @description Filters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues.
+ * Note that `username` and `userkey` can't be used as search terms for this parameter due to privacy reasons. Use `accountId` instead.
+ */
+ jql?: string;
+ /** @description Specifies whether to validate the JQL query or not. Default: true. */
+ validateQuery?: boolean;
+ /** @description The list of fields to return for each issue. By default, all navigable and Agile fields are returned. */
+ fields?: Record[];
+ /** @description A comma-separated list of the parameters to expand. */
+ expand?: string;
+ };
+ path: {
+ /** @description The ID of the board that contains requested issues. */
+ boardId: number;
+ /** @description The ID of the sprint that contains requested issues. */
+ sprintId: number;
+ };
+ };
+ responses: {
+ /** @description Returns the requested issues, at the specified page of the results. */
+ 200: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not a have valid license. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the board does not exist or the user does not have permission to view it. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get all versions
+ * @description Returns all versions from a board, for a given board ID. This only includes versions that the user has permission to view. Note, if the user does not have permission to view the board, no versions will be returned at all. Returned versions are ordered by the name of the project from which they belong and then by sequence defined by user.
+ */
+ getAllVersions: {
+ parameters: {
+ query?: {
+ /** @description The starting index of the returned versions. Base index: 0. See the 'Pagination' section at the top of this page for more details. */
+ startAt?: number;
+ /** @description The maximum number of versions to return per page. See the 'Pagination' section at the top of this page for more details. */
+ maxResults?: number;
+ /** @description Filters results to versions that are either released or unreleased. Valid values: true, false. */
+ released?: string;
+ };
+ path: {
+ /** @description The ID of the board that contains the requested versions. */
+ boardId: number;
+ };
+ };
+ responses: {
+ /** @description Returns the requested versions, at the specified page of the results. */
+ 200: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not a have valid license. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if board does not exist or the user does not have permission to view it. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get issues without epic
+ * @description Returns all issues that do not belong to any epic. This only includes issues that the user has permission to view. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank. **Note:** If you are querying a next-gen project, do not use this operation. Instead, search for issues that don't belong to an epic by using the [Search for issues using JQL](https://developer.atlassian.com/cloud/jira/platform/rest/v2/#api-rest-api-2-search-get) operation in the Jira platform REST API. Build your JQL query using the `parent is empty` clause. For more information on the `parent` JQL field, see [Advanced searching](https://confluence.atlassian.com/x/dAiiLQ#Advancedsearching-fieldsreference-Parent).
+ */
+ getIssuesWithoutEpic: {
+ parameters: {
+ query?: {
+ /** @description The starting index of the returned issues. Base index: 0. See the 'Pagination' section at the top of this page for more details. */
+ startAt?: number;
+ /** @description The maximum number of issues to return per page. See the 'Pagination' section at the top of this page for more details. Note, the total number of issues returned is limited by the property 'jira.search.views.default.max' in your Jira instance. If you exceed this limit, your results will be truncated. */
+ maxResults?: number;
+ /** @description Filters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues. */
+ jql?: string;
+ /** @description Specifies whether to validate the JQL query or not. Default: true. */
+ validateQuery?: boolean;
+ /** @description The list of fields to return for each issue. By default, all navigable and Agile fields are returned. */
+ fields?: Record[];
+ /** @description A comma-separated list of the parameters to expand. */
+ expand?: string;
+ };
+ };
+ responses: {
+ /** @description Returns the requested issues, at the specified page of the results. */
+ 200: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not a have valid license. */
+ 403: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Remove issues from epic
+ * @description Removes issues from epics. The user needs to have the edit issue permission for all issue they want to remove from epics. The maximum number of issues that can be moved in one operation is 50. **Note:** This operation does not work for epics in next-gen projects. Instead, update the issue using `\{ fields: \{ parent: \{\} \} \}`
+ */
+ removeIssuesFromEpic: {
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "issues": [
+ * "PR-1",
+ * "10001",
+ * "PR-3"
+ * ]
+ * }
+ */
+ "application/json": {
+ issues?: string[];
+ };
+ };
+ };
+ responses: {
+ /** @description Empty response is returned if operation was successful. */
+ 204: {
+ content: never;
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not a have valid license or does not have permission to assign issues. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the epic does not exist or the user does not have permission to view it. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get epic
+ * @description Returns the epic for a given epic ID. This epic will only be returned if the user has permission to view it. **Note:** This operation does not work for epics in next-gen projects.
+ */
+ getEpic: {
+ parameters: {
+ path: {
+ /** @description The id or key of the requested epic. */
+ epicIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Returns the requested epic. */
+ 200: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not a have valid license. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the epic does not exist or the user does not have permission to view it. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Partially update epic
+ * @description Performs a partial update of the epic. A partial update means that fields not present in the request JSON will not be updated. Valid values for color are `color_1` to `color_9`. **Note:** This operation does not work for epics in next-gen projects.
+ */
+ partiallyUpdateEpic: {
+ parameters: {
+ path: {
+ /** @description The id or key of the epic to update. */
+ epicIdOrKey: string;
+ };
+ };
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "summary": "epic 2 summary",
+ * "color": {
+ * "key": "color_6"
+ * },
+ * "name": "epic 2",
+ * "done": true
+ * }
+ */
+ "application/json": {
+ name?: string;
+ summary?: string;
+ color?: {
+ /** @enum {string} */
+ key?:
+ | "color_1"
+ | "color_2"
+ | "color_3"
+ | "color_4"
+ | "color_5"
+ | "color_6"
+ | "color_7"
+ | "color_8"
+ | "color_9"
+ | "color_10"
+ | "color_11"
+ | "color_12"
+ | "color_13"
+ | "color_14";
+ };
+ done?: boolean;
+ };
+ };
+ };
+ responses: {
+ /** @description Updated epic */
+ 200: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not a have valid license or edit issue permission. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the epic does not exist or the user does not have permission to view it. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get issues for epic
+ * @description Returns all issues that belong to the epic, for the given epic ID. This only includes issues that the user has permission to view. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank. **Note:** If you are querying a next-gen project, do not use this operation. Instead, search for issues that belong to an epic by using the [Search for issues using JQL](https://developer.atlassian.com/cloud/jira/platform/rest/v2/#api-rest-api-2-search-get) operation in the Jira platform REST API. Build your JQL query using the `parent` clause. For more information on the `parent` JQL field, see [Advanced searching](https://confluence.atlassian.com/x/dAiiLQ#Advancedsearching-fieldsreference-Parent).
+ */
+ getIssuesForEpic: {
+ parameters: {
+ query?: {
+ /** @description The starting index of the returned issues. Base index: 0. See the 'Pagination' section at the top of this page for more details. */
+ startAt?: number;
+ /** @description The maximum number of issues to return per page. Default: 50. See the 'Pagination' section at the top of this page for more details. Note, the total number of issues returned is limited by the property 'jira.search.views.default.max' in your Jira instance. If you exceed this limit, your results will be truncated. */
+ maxResults?: number;
+ /**
+ * @description Filters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues.
+ * Note that `username` and `userkey` can't be used as search terms for this parameter due to privacy reasons. Use `accountId` instead.
+ */
+ jql?: string;
+ /** @description Specifies whether to validate the JQL query or not. Default: true. */
+ validateQuery?: boolean;
+ /** @description The list of fields to return for each issue. By default, all navigable and Agile fields are returned. */
+ fields?: Record[];
+ /** @description A comma-separated list of the parameters to expand. */
+ expand?: string;
+ };
+ path: {
+ /** @description The id or key of the epic that contains the requested issues. */
+ epicIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Returns the requested issues, at the specified page of the results. */
+ 200: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not a have valid license. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the epic does not exist or the user does not have permission to view it. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Move issues to epic
+ * @description Moves issues to an epic, for a given epic id. Issues can be only in a single epic at the same time. That means that already assigned issues to an epic, will not be assigned to the previous epic anymore. The user needs to have the edit issue permission for all issue they want to move and to the epic. The maximum number of issues that can be moved in one operation is 50. **Note:** This operation does not work for epics in next-gen projects.
+ */
+ moveIssuesToEpic: {
+ parameters: {
+ path: {
+ /** @description The id or key of the epic that you want to assign issues to. */
+ epicIdOrKey: string;
+ };
+ };
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "issues": [
+ * "PR-1",
+ * "10001",
+ * "PR-3"
+ * ]
+ * }
+ */
+ "application/json": {
+ issues?: string[];
+ };
+ };
+ };
+ responses: {
+ /** @description Empty response is returned if operation was successful. */
+ 204: {
+ content: never;
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not a have valid license or does not have edit issue permission for all issues to assign or for the epic. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the epic does not exist or the user does not have permission to view it. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Rank epics
+ * @description Moves (ranks) an epic before or after a given epic.
+ *
+ * If rankCustomFieldId is not defined, the default rank field will be used.
+ *
+ * **Note:** This operation does not work for epics in next-gen projects.
+ */
+ rankEpics: {
+ parameters: {
+ path: {
+ /** @description The id or key of the epic to rank. */
+ epicIdOrKey: string;
+ };
+ };
+ /** @description bean which contains the information where the given epic should be ranked. */
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "rankBeforeEpic": "10000",
+ * "rankCustomFieldId": 10521
+ * }
+ */
+ "application/json": {
+ rankBeforeEpic?: string;
+ rankAfterEpic?: string;
+ /** Format: int64 */
+ rankCustomFieldId?: number;
+ };
+ };
+ };
+ responses: {
+ /** @description Empty response is returned if operation was successful. */
+ 204: {
+ content: never;
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if user does not a have valid license or does not have permission to rank. To rank issues user have to have schedule issue permission for epics that they want to rank. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned when the given epics in the path parameter or the request body do not exist. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Rank issues
+ * @description Moves (ranks) issues before or after a given issue. At most 50 issues may be ranked at once.
+ *
+ * This operation may fail for some issues, although this will be rare. In that case the 207 status code is returned for the whole response and detailed information regarding each issue is available in the response body.
+ *
+ * If rankCustomFieldId is not defined, the default rank field will be used.
+ */
+ rankIssues: {
+ /** @description bean which contains list of issues to rank and information where it should be ranked. */
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "rankBeforeIssue": "PR-4",
+ * "rankCustomFieldId": 10521,
+ * "issues": [
+ * "PR-1",
+ * "10001",
+ * "PR-3"
+ * ]
+ * }
+ */
+ "application/json": {
+ issues?: string[];
+ rankBeforeIssue?: string;
+ rankAfterIssue?: string;
+ /** Format: int64 */
+ rankCustomFieldId?: number;
+ };
+ };
+ };
+ responses: {
+ /** @description Empty response is returned if operation was successful. */
+ 204: {
+ content: never;
+ };
+ /** @description Returns the list of issue with status of rank operation. */
+ 207: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if user does not a have valid license or does not have permission to rank. To rank issues user has to have schedule issue permission for issues that they want to rank. */
+ 403: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get issue
+ * @description Returns a single issue, for a given issue ID or issue key. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic.
+ */
+ getIssue: {
+ parameters: {
+ query?: {
+ /** @description The list of fields to return for each issue. By default, all navigable and Agile fields are returned. */
+ fields?: Record[];
+ /** @description A comma-separated list of the parameters to expand. */
+ expand?: string;
+ /** @description A boolean indicating whether the issue retrieved by this method should be added to the current user's issue history */
+ updateHistory?: boolean;
+ };
+ path: {
+ /** @description The ID or key of the requested issue. */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Returns the requested issue. */
+ 200: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not a have valid license. */
+ 403: {
+ content: never;
+ };
+ /**
+ * @description Returned in these cases:
+ *
+ * * the issue does not exist
+ * * the user does not have permission to view issue
+ */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get issue estimation for board
+ * @description Returns the estimation of the issue and a fieldId of the field that is used for it. `boardId` param is required. This param determines which field will be updated on a issue.
+ *
+ * Original time internally stores and returns the estimation as a number of seconds.
+ *
+ * The field used for estimation on the given board can be obtained from [board configuration resource](#agile/1.0/board-getConfiguration). More information about the field are returned by [edit meta resource](#api-rest-api-3-issue-getEditIssueMeta) or [field resource](#api-rest-api-3-field-get).
+ */
+ getIssueEstimationForBoard: {
+ parameters: {
+ query?: {
+ /** @description The ID of the board required to determine which field is used for estimation. */
+ boardId?: number;
+ };
+ path: {
+ /** @description The ID or key of the requested issue. */
+ issueIdOrKey: string;
+ };
+ };
+ responses: {
+ /** @description Returns the estimation of the issue and a fieldId of the field that is used for it. */
+ 200: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the boardId was not provided, field does not exists or value was in wrong format. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if user does not a have valid license or does not have permission to edit issue. */
+ 403: {
+ content: never;
+ };
+ /**
+ * @description Returned in these cases:
+ *
+ * * the issue does not exist
+ * * the user does not have permission to view issue
+ * * the board does not exist
+ * * the user does not have permission to view board
+ * * the issue does not belong to the board
+ */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Estimate issue for board
+ * @description Updates the estimation of the issue. boardId param is required. This param determines which field will be updated on a issue.
+ *
+ * Note that this resource changes the estimation field of the issue regardless of appearance the field on the screen.
+ *
+ * Original time tracking estimation field accepts estimation in formats like "1w", "2d", "3h", "20m" or number which represent number of minutes. However, internally the field stores and returns the estimation as a number of seconds.
+ *
+ * The field used for estimation on the given board can be obtained from [board configuration resource](#agile/1.0/board-getConfiguration). More information about the field are returned by [edit meta resource](#api-rest-api-3-issue-issueIdOrKey-editmeta-get) or [field resource](#api-rest-api-3-field-get).
+ */
+ estimateIssueForBoard: {
+ parameters: {
+ query?: {
+ /** @description The ID of the board required to determine which field is used for estimation. */
+ boardId?: number;
+ };
+ path: {
+ /** @description The ID or key of the requested issue. */
+ issueIdOrKey: string;
+ };
+ };
+ /** @description bean that contains value of a new estimation. */
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "value": "8.0"
+ * }
+ */
+ "application/json": {
+ value?: string;
+ };
+ };
+ };
+ responses: {
+ /** @description Returns the estimation of the issue and a fieldId of the field that is used for it. */
+ 200: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the boardId was not provided, field does not exists or value was in wrong format. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if user does not a have valid license or does not have permission to edit issue. */
+ 403: {
+ content: never;
+ };
+ /**
+ * @description Returned in these cases:
+ *
+ * * the issue does not exist
+ * * the user does not have permission to view issue
+ * * the board does not exist
+ * * the user does not have permission to view board
+ * * the issue does not belong to the board
+ */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Create sprint
+ * @description Creates a future sprint. Sprint name and origin board id are required. Start date, end date, and goal are optional.
+ *
+ * Note that the sprint name is trimmed. Also, when starting sprints from the UI, the "endDate" set through this call is ignored and instead the last sprint's duration is used to fill the form.
+ */
+ createSprint: {
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "originBoardId": 5,
+ * "goal": "sprint 1 goal",
+ * "endDate": "2015-04-20T01:22:00.000+10:00",
+ * "name": "sprint 1",
+ * "startDate": "2015-04-11T15:22:00.000+10:00"
+ * }
+ */
+ "application/json": {
+ name?: string;
+ startDate?: string;
+ endDate?: string;
+ /** Format: int64 */
+ originBoardId?: number;
+ goal?: string;
+ };
+ };
+ };
+ responses: {
+ /** @description Created sprint */
+ 201: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not a have valid license. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the board does not exist or the user does not have permission to view it. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get sprint
+ * @description Returns the sprint for a given sprint ID. The sprint will only be returned if the user can view the board that the sprint was created on, or view at least one of the issues in the sprint.
+ */
+ getSprint: {
+ parameters: {
+ path: {
+ /** @description The ID of the requested sprint. */
+ sprintId: number;
+ };
+ };
+ responses: {
+ /** @description Returns the requested sprint. */
+ 200: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not a have valid license. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the sprint does not exist or the user does not have permission to view it. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Update sprint
+ * @description Performs a full update of a sprint. A full update means that the result will be exactly the same as the request body. Any fields not present in the request JSON will be set to null.
+ *
+ * Notes:
+ *
+ * * Sprints that are in a closed state cannot be updated.
+ * * A sprint can be started by updating the state to 'active'. This requires the sprint to be in the 'future' state and have a startDate and endDate set.
+ * * A sprint can be completed by updating the state to 'closed'. This action requires the sprint to be in the 'active' state. This sets the completeDate to the time of the request.
+ * * Other changes to state are not allowed.
+ * * The completeDate field cannot be updated manually.
+ */
+ updateSprint: {
+ parameters: {
+ path: {
+ /** @description the ID of the sprint to update. */
+ sprintId: number;
+ };
+ };
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "goal": "sprint 1 goal",
+ * "endDate": "2015-04-16T14:01:00.000+10:00",
+ * "name": "sprint 1",
+ * "state": "closed",
+ * "startDate": "2015-04-11T15:36:00.000+10:00",
+ * "completeDate": "2015-04-20T11:11:28.008+10:00"
+ * }
+ */
+ "application/json": {
+ /** Format: int64 */
+ id?: number;
+ /** Format: uri */
+ self?: string;
+ state?: string;
+ name?: string;
+ startDate?: string;
+ endDate?: string;
+ completeDate?: string;
+ createdDate?: string;
+ /** Format: int64 */
+ originBoardId?: number;
+ goal?: string;
+ };
+ };
+ };
+ responses: {
+ /** @description Updated sprint */
+ 200: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not a have valid license. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the sprint does not exist. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Partially update sprint
+ * @description Performs a partial update of a sprint. A partial update means that fields not present in the request JSON will not be updated.
+ *
+ * Notes:
+ *
+ * * Sprints that are in a closed state cannot be updated.
+ * * A sprint can be started by updating the state to 'active'. This requires the sprint to be in the 'future' state and have a startDate and endDate set.
+ * * A sprint can be completed by updating the state to 'closed'. This action requires the sprint to be in the 'active' state. This sets the completeDate to the time of the request.
+ * * Other changes to state are not allowed.
+ * * The completeDate field cannot be updated manually.
+ */
+ partiallyUpdateSprint: {
+ parameters: {
+ path: {
+ /** @description The ID of the sprint to update. */
+ sprintId: number;
+ };
+ };
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "name": "new name"
+ * }
+ */
+ "application/json": {
+ /** Format: int64 */
+ id?: number;
+ /** Format: uri */
+ self?: string;
+ state?: string;
+ name?: string;
+ startDate?: string;
+ endDate?: string;
+ completeDate?: string;
+ createdDate?: string;
+ /** Format: int64 */
+ originBoardId?: number;
+ goal?: string;
+ };
+ };
+ };
+ responses: {
+ /** @description Updated sprint */
+ 200: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not a have valid license. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the sprint does not exist. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Delete sprint
+ * @description Deletes a sprint. Once a sprint is deleted, all open issues in the sprint will be moved to the backlog.
+ */
+ deleteSprint: {
+ parameters: {
+ path: {
+ /** @description The ID of the sprint to delete. */
+ sprintId: number;
+ };
+ };
+ responses: {
+ /** @description Returned if the sprint was deleted successfully */
+ 204: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not a have valid license or does not have permission to delete sprints. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the sprint does not exist. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get issues for sprint
+ * @description Returns all issues in a sprint, for a given sprint ID. This only includes issues that the user has permission to view. By default, the returned issues are ordered by rank.
+ */
+ getIssuesForSprint: {
+ parameters: {
+ query?: {
+ /** @description The starting index of the returned issues. Base index: 0. See the 'Pagination' section at the top of this page for more details. */
+ startAt?: number;
+ /** @description The maximum number of issues to return per page. See the 'Pagination' section at the top of this page for more details. Note, the total number of issues returned is limited by the property 'jira.search.views.default.max' in your Jira instance. If you exceed this limit, your results will be truncated. */
+ maxResults?: number;
+ /**
+ * @description Filters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues.
+ * Note that `username` and `userkey` can't be used as search terms for this parameter due to privacy reasons. Use `accountId` instead.
+ */
+ jql?: string;
+ /** @description Specifies whether to validate the JQL query or not. Default: true. */
+ validateQuery?: boolean;
+ /** @description The list of fields to return for each issue. By default, all navigable and Agile fields are returned. */
+ fields?: Record[];
+ /** @description A comma-separated list of the parameters to expand. */
+ expand?: string;
+ };
+ path: {
+ /** @description The ID of the sprint that contains the requested issues. */
+ sprintId: number;
+ };
+ };
+ responses: {
+ /** @description Returns the requested issues, at the specified page of the results. */
+ 200: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not a have valid license. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if sprint does not exist or the user cannot view it. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Move issues to sprint and rank
+ * @description Moves issues to a sprint, for a given sprint ID. Issues can only be moved to open or active sprints. The maximum number of issues that can be moved in one operation is 50.
+ */
+ moveIssuesToSprintAndRank: {
+ parameters: {
+ path: {
+ /** @description The ID of the sprint that you want to assign issues to. */
+ sprintId: number;
+ };
+ };
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "rankBeforeIssue": "PR-4",
+ * "rankCustomFieldId": 10521,
+ * "issues": [
+ * "PR-1",
+ * "10001",
+ * "PR-3"
+ * ]
+ * }
+ */
+ "application/json": {
+ issues?: string[];
+ rankBeforeIssue?: string;
+ rankAfterIssue?: string;
+ /** Format: int64 */
+ rankCustomFieldId?: number;
+ };
+ };
+ };
+ responses: {
+ /** @description Empty response is returned if operation was successful. */
+ 204: {
+ content: never;
+ };
+ /** @description Returned if the request is invalid. */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not a have valid license or does not have permission to assign issues. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the sprint does not exist or the user does not have permission to view it. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get properties keys
+ * @description Returns the keys of all properties for the sprint identified by the id. The user who retrieves the property keys is required to have permissions to view the sprint.
+ */
+ getPropertiesKeys: {
+ parameters: {
+ path: {
+ /** @description the ID of the sprint from which property keys will be returned. */
+ sprintId: string;
+ };
+ };
+ responses: {
+ /** @description Returned if the sprint with given id exists. */
+ 200: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the sprintId is invalid (negative or not a number). */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the calling user is not authenticated. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the calling user does not have permission to view the sprint. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the sprint with given id does not exist. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get property
+ * @description Returns the value of the property with a given key from the sprint identified by the provided id. The user who retrieves the property is required to have permissions to view the sprint.
+ */
+ getProperty: {
+ parameters: {
+ path: {
+ /** @description the ID of the sprint from which the property will be returned. */
+ sprintId: string;
+ /** @description the key of the property to return. */
+ propertyKey: string;
+ };
+ };
+ responses: {
+ /** @description Returned if the sprint exists and the property was found. */
+ 200: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ /** @description Returned if the sprintId is invalid (negative or not a number). */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the calling user is not authenticated. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the calling user does not have permission to view the sprint. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the sprint with a given id does not exist or if the property with given key is not found. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Set property
+ * @description Sets the value of the specified sprint's property.
+ *
+ * You can use this resource to store a custom data against the sprint identified by the id. The user who stores the data is required to have permissions to modify the sprint.
+ */
+ setProperty: {
+ parameters: {
+ path: {
+ /** @description the ID of the sprint on which the property will be set. */
+ sprintId: string;
+ /** @description the key of the sprint's property. The maximum length of the key is 255 bytes. */
+ propertyKey: string;
+ };
+ };
+ responses: {
+ /** @description Returned if the sprint property is successfully updated. */
+ 200: {
+ content: never;
+ };
+ /** @description Returned if the sprint property is successfully created. */
+ 201: {
+ content: never;
+ };
+ /** @description Returned if the sprintId is invalid (negative or not a number). */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the calling user is not authenticated. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the calling user does not have permission to edit the sprint */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the sprint with given id does not exist. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Delete property
+ * @description Removes the property from the sprint identified by the id. Ths user removing the property is required to have permissions to modify the sprint.
+ */
+ deleteProperty: {
+ parameters: {
+ path: {
+ /** @description the ID of the sprint from which the property will be removed. */
+ sprintId: string;
+ /** @description the key of the property to remove. */
+ propertyKey: string;
+ };
+ };
+ responses: {
+ /** @description Returned if the sprint property was removed successfully. */
+ 204: {
+ content: never;
+ };
+ /** @description Returned if the sprintId is invalid (negative or not a number). */
+ 400: {
+ content: never;
+ };
+ /** @description Returned if the calling user is not authenticated. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the calling user does not have permission to modify the sprint. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if the sprint with given id does not exist or if the property with given key is not found. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Swap sprint
+ * @description Swap the position of the sprint with the second sprint.
+ */
+ swapSprint: {
+ parameters: {
+ path: {
+ /** @description The ID of the sprint to swap. */
+ sprintId: number;
+ };
+ };
+ requestBody: {
+ content: {
+ /**
+ * @example {
+ * "sprintToSwapWith": 3
+ * }
+ */
+ "application/json": {
+ /** Format: int64 */
+ sprintToSwapWith?: number;
+ };
+ };
+ };
+ responses: {
+ /** @description Returned if the sprint swap was performed successfully */
+ 204: {
+ content: never;
+ };
+ /** @description Returned if the user is not logged in. */
+ 401: {
+ content: never;
+ };
+ /** @description Returned if the user does not a have valid license or does not have permission to at least one sprint. */
+ 403: {
+ content: never;
+ };
+ /** @description Returned if at least one sprint does not exist or user does not have permission to view to at least one sprint. */
+ 404: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Store development information
+ * @description Stores development information provided in the request to make it available when viewing issues in Jira. Existing repository and entity data for the same ID will be replaced if the updateSequenceId of existing data is less than the incoming data. Submissions are performed asynchronously. Submitted data will eventually be available in Jira; most updates are available within a short period of time, but may take some time during peak load and/or maintenance times.
+ */
+ storeDevelopmentInformation: {
+ parameters: {
+ header: {
+ /** @description All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that corresponds to an app installed in Jira. If the JWT token corresponds to a Connect app that does not define the jiraDevelopmentTool module it will be rejected with a 403. See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens. See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations. */
+ Authorization: string;
+ };
+ };
+ /** @description Request object, which contains development information */
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description List of repositories containing development information. Must not contain duplicates. Maximum number of entities across all repositories is 1000. */
+ repositories: {
+ /**
+ * @description The name of this repository. Max length is 255 characters.
+ * @example atlassian-connect-jira-example
+ */
+ name: string;
+ /**
+ * @description Description of this repository. Max length is 1024 characters.
+ * @example The repository which stores code of the Atlassian Connect Add-on Devinfo application.
+ */
+ description?: string;
+ /**
+ * @description The ID of the repository this repository was forked from, if it's a fork. Max length is 1024 characters.
+ * @example 56c7c750-cee2-48e2-b920-d7706dfd11f7
+ */
+ forkOf?: string;
+ /**
+ * Format: url
+ * @description The URL of this repository. Max length is 2000 characters.
+ * @example https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example
+ */
+ url: string;
+ /** @description List of commits to update in this repository. Must not contain duplicate entity IDs. Maximum number of commits is 400 */
+ commits?: {
+ /**
+ * @description The identifier or hash of the commit. Will be used for cross entity linking. Must be unique for all commits within a repository, i.e., only one commit can have ID 'X' in repository 'Y'. But adding, e.g., a branch with ID 'X' to repository 'Y' is acceptable. Only alphanumeric characters, and '~.-_', are allowed. Max length is 1024 characters
+ * @example a7727ee6350c33cdf90826dc21abaa26a5704370
+ */
+ id: string;
+ /**
+ * @description List of issues keys that this entity is associated with. They must be valid Jira issue keys.
+ * @example ["ISSUE-1","TEST-2"]
+ */
+ issueKeys: string[];
+ /**
+ * Format: int64
+ * @description An ID used to apply an ordering to updates for this entity in the case of out-of-order receipt of update requests. This can be any monotonically increasing number. A suggested implementation is to use epoch millis from the provider system, but other alternatives are valid (e.g. a provider could store a counter against each entity and increment that on each update to Jira). Updates for an entity that are received with an updateSqeuenceId lower than what is currently stored will be ignored.
+ * @example 1523494301248
+ */
+ updateSequenceId: number;
+ /** @description Deprecated. Use the id field instead. */
+ hash?: string;
+ /**
+ * @description The set of flags for this commit
+ * @example [MERGE_COMMIT]
+ */
+ flags?: "MERGE_COMMIT"[];
+ /**
+ * @description The commit message. Max length is 1024 characters. If anything longer is supplied, it will be truncated down to 1024 characters.
+ * @example README.md edited online with Bitbucket
+ */
+ message: string;
+ /**
+ * Author
+ * @description Describes the author of a particular entity
+ */
+ author: {
+ /**
+ * @description Deprecated. The name of this user in a format suitable for display. Max length is 255 characters.
+ * @example Jane Doe
+ */
+ name?: string;
+ /**
+ * @description The email address of the user. Used to associate the user with a Jira user. Max length is 255 characters.
+ * @example jane_doe@atlassian.com
+ */
+ email?: string;
+ /**
+ * @description Deprecated. The username of the user. Used to associate the user with a Jira user if there are multiple users for a given email. Max length is 255 characters.
+ * @example jdoe
+ */
+ username?: string;
+ /**
+ * @description Deprecated. The URL of the profile for this user. Max length is 2000 characters.
+ * @example https://atlassian.com/account/jane_doe
+ */
+ url?: string;
+ /**
+ * @description Deprecated. The URL of the avatar for this user. Max length is 2000 characters.
+ * @example https://atlassian.com/account/jane_doe/avatar/32
+ */
+ avatar?: string;
+ };
+ /**
+ * Format: int32
+ * @description The total number of files added, removed, or modified by this commit
+ * @example 1
+ */
+ fileCount: number;
+ /**
+ * Format: url
+ * @description The URL of this commit. Max length is 2000 characters.
+ * @example https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/commits/a7727ee6350c33cdf90826dc21abaa26a5704370
+ */
+ url: string;
+ /** @description List of file changes. Max number of files is 10. Currently, only the first 5 files are shown (sorted by path) in the UI. This UI behavior may change without notice. */
+ files?: {
+ /**
+ * @description The path of the file. Max length is 1024 characters.
+ * @example /home/user/src/atlassian-connect-jira-example/README.md
+ */
+ path: string;
+ /**
+ * Format: url
+ * @description The URL of this file. Max length is 2000 characters.
+ * @example https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/src/a7727ee6350c33cdf90826dc21abaa26a5704370/README.md
+ */
+ url: string;
+ /**
+ * @description The operation performed on this file
+ * @example MODIFIED
+ * @enum {string}
+ */
+ changeType: "ADDED" | "COPIED" | "DELETED" | "MODIFIED" | "MOVED" | "UNKNOWN";
+ /**
+ * Format: int32
+ * @description Number of lines added to the file
+ * @example 0
+ */
+ linesAdded: number;
+ /**
+ * Format: int32
+ * @description Number of lines removed from the file
+ * @example 1
+ */
+ linesRemoved: number;
+ }[];
+ /**
+ * @description The author timestamp of this commit. Formatted as a UTC ISO 8601 date time format.
+ * @example 2016-10-31T23:27:25+00:00
+ */
+ authorTimestamp: string;
+ /**
+ * @description Shortened identifier for this commit, used for display. Max length is 255 characters.
+ * @example a7727ee
+ */
+ displayId: string;
+ }[];
+ /** @description List of branches to update in this repository. Must not contain duplicate entity IDs. Maximum number of branches is 400. */
+ branches?: {
+ /**
+ * @description The ID of this entity. Will be used for cross entity linking. Must be unique by entity type within a repository, i.e., only one commit can have ID 'X' in repository 'Y'. But adding, e.g., a branch with ID 'X' to repository 'Y' is acceptable. Only alphanumeric characters, and '~.-_', are allowed. Max length is 1024 characters.
+ * @example c6c7c750-cee2-48e2-b920-d7706dfd11f9
+ */
+ id: string;
+ /**
+ * @description List of issues keys that this entity is associated with. They must be valid Jira issue keys.
+ * @example ["ISSUE-1","TEST-2"]
+ */
+ issueKeys: string[];
+ /**
+ * Format: int64
+ * @description An ID used to apply an ordering to updates for this entity in the case of out-of-order receipt of update requests. This can be any monotonically increasing number. A suggested implementation is to use epoch millis from the provider system, but other alternatives are valid (e.g. a provider could store a counter against each entity and increment that on each update to Jira). Updates for an entity that are received with an updateSqeuenceId lower than what is currently stored will be ignored.
+ * @example 1523494301248
+ */
+ updateSequenceId: number;
+ /**
+ * @description The name of the branch. Max length is 512 characters.
+ * @example master
+ */
+ name: string;
+ /**
+ * Commit
+ * @description Represents a commit in the version control system.
+ */
+ lastCommit: {
+ /**
+ * @description The identifier or hash of the commit. Will be used for cross entity linking. Must be unique for all commits within a repository, i.e., only one commit can have ID 'X' in repository 'Y'. But adding, e.g., a branch with ID 'X' to repository 'Y' is acceptable. Only alphanumeric characters, and '~.-_', are allowed. Max length is 1024 characters
+ * @example a7727ee6350c33cdf90826dc21abaa26a5704370
+ */
+ id: string;
+ /**
+ * @description List of issues keys that this entity is associated with. They must be valid Jira issue keys.
+ * @example ["ISSUE-1","TEST-2"]
+ */
+ issueKeys: string[];
+ /**
+ * Format: int64
+ * @description An ID used to apply an ordering to updates for this entity in the case of out-of-order receipt of update requests. This can be any monotonically increasing number. A suggested implementation is to use epoch millis from the provider system, but other alternatives are valid (e.g. a provider could store a counter against each entity and increment that on each update to Jira). Updates for an entity that are received with an updateSqeuenceId lower than what is currently stored will be ignored.
+ * @example 1523494301248
+ */
+ updateSequenceId: number;
+ /** @description Deprecated. Use the id field instead. */
+ hash?: string;
+ /**
+ * @description The set of flags for this commit
+ * @example [MERGE_COMMIT]
+ */
+ flags?: "MERGE_COMMIT"[];
+ /**
+ * @description The commit message. Max length is 1024 characters. If anything longer is supplied, it will be truncated down to 1024 characters.
+ * @example README.md edited online with Bitbucket
+ */
+ message: string;
+ /**
+ * Author
+ * @description Describes the author of a particular entity
+ */
+ author: {
+ /**
+ * @description Deprecated. The name of this user in a format suitable for display. Max length is 255 characters.
+ * @example Jane Doe
+ */
+ name?: string;
+ /**
+ * @description The email address of the user. Used to associate the user with a Jira user. Max length is 255 characters.
+ * @example jane_doe@atlassian.com
+ */
+ email?: string;
+ /**
+ * @description Deprecated. The username of the user. Used to associate the user with a Jira user if there are multiple users for a given email. Max length is 255 characters.
+ * @example jdoe
+ */
+ username?: string;
+ /**
+ * @description Deprecated. The URL of the profile for this user. Max length is 2000 characters.
+ * @example https://atlassian.com/account/jane_doe
+ */
+ url?: string;
+ /**
+ * @description Deprecated. The URL of the avatar for this user. Max length is 2000 characters.
+ * @example https://atlassian.com/account/jane_doe/avatar/32
+ */
+ avatar?: string;
+ };
+ /**
+ * Format: int32
+ * @description The total number of files added, removed, or modified by this commit
+ * @example 1
+ */
+ fileCount: number;
+ /**
+ * Format: url
+ * @description The URL of this commit. Max length is 2000 characters.
+ * @example https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/commits/a7727ee6350c33cdf90826dc21abaa26a5704370
+ */
+ url: string;
+ /** @description List of file changes. Max number of files is 10. Currently, only the first 5 files are shown (sorted by path) in the UI. This UI behavior may change without notice. */
+ files?: {
+ /**
+ * @description The path of the file. Max length is 1024 characters.
+ * @example /home/user/src/atlassian-connect-jira-example/README.md
+ */
+ path: string;
+ /**
+ * Format: url
+ * @description The URL of this file. Max length is 2000 characters.
+ * @example https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/src/a7727ee6350c33cdf90826dc21abaa26a5704370/README.md
+ */
+ url: string;
+ /**
+ * @description The operation performed on this file
+ * @example MODIFIED
+ * @enum {string}
+ */
+ changeType: "ADDED" | "COPIED" | "DELETED" | "MODIFIED" | "MOVED" | "UNKNOWN";
+ /**
+ * Format: int32
+ * @description Number of lines added to the file
+ * @example 0
+ */
+ linesAdded: number;
+ /**
+ * Format: int32
+ * @description Number of lines removed from the file
+ * @example 1
+ */
+ linesRemoved: number;
+ }[];
+ /**
+ * @description The author timestamp of this commit. Formatted as a UTC ISO 8601 date time format.
+ * @example 2016-10-31T23:27:25+00:00
+ */
+ authorTimestamp: string;
+ /**
+ * @description Shortened identifier for this commit, used for display. Max length is 255 characters.
+ * @example a7727ee
+ */
+ displayId: string;
+ };
+ /**
+ * @description The URL of the page for creating a pull request from this branch. Max length is 2000 characters.
+ * @example https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/pull-requests/new
+ */
+ createPullRequestUrl?: string;
+ /**
+ * @description The URL of the branch. Max length is 2000 characters.
+ * @example https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/branch/master
+ */
+ url: string;
+ }[];
+ /** @description List of pull requests to update in this repository. Must not contain duplicate entity IDs. Maximum number of pull requests is 400 */
+ pullRequests?: {
+ /**
+ * @description The ID of this entity. Will be used for cross entity linking. Must be unique by entity type within a repository, i.e., only one commit can have ID 'X' in repository 'Y'. But adding, e.g., a branch with ID 'X' to repository 'Y' is acceptable. Only alphanumeric characters, and '~.-_', are allowed. Max length is 1024 characters
+ * @example c6c7c750-cee2-48e2-b920-d7706dfd11f9
+ */
+ id: string;
+ /**
+ * @description List of issues keys that this entity is associated with. They must be valid Jira issue keys.
+ * @example ["ISSUE-1","TEST-2"]
+ */
+ issueKeys: string[];
+ /**
+ * Format: int64
+ * @description An ID used to apply an ordering to updates for this entity in the case of out-of-order receipt of update requests. This can be any monotonically increasing number. A suggested implementation is to use epoch millis from the provider system, but other alternatives are valid (e.g. a provider could store a counter against each entity and increment that on each update to Jira). Updates for an entity that are received with an updateSqeuenceId lower than what is currently stored will be ignored.
+ * @example 1523494301248
+ */
+ updateSequenceId: number;
+ /**
+ * @description The status of the pull request. In the case of concurrent updates, priority is given in the order OPEN, MERGED, DECLINED, DRAFT, UNKNOWN
+ * @example OPEN
+ * @enum {string}
+ */
+ status: "OPEN" | "MERGED" | "DECLINED" | "DRAFT" | "UNKNOWN";
+ /**
+ * @description Title of the pull request. Max length is 1024 characters.
+ * @example Pull request 2, fixing all the issues caused by pull request #1
+ */
+ title: string;
+ /**
+ * Author
+ * @description Describes the author of a particular entity
+ */
+ author: {
+ /**
+ * @description Deprecated. The name of this user in a format suitable for display. Max length is 255 characters.
+ * @example Jane Doe
+ */
+ name?: string;
+ /**
+ * @description The email address of the user. Used to associate the user with a Jira user. Max length is 255 characters.
+ * @example jane_doe@atlassian.com
+ */
+ email?: string;
+ /**
+ * @description Deprecated. The username of the user. Used to associate the user with a Jira user if there are multiple users for a given email. Max length is 255 characters.
+ * @example jdoe
+ */
+ username?: string;
+ /**
+ * @description Deprecated. The URL of the profile for this user. Max length is 2000 characters.
+ * @example https://atlassian.com/account/jane_doe
+ */
+ url?: string;
+ /**
+ * @description Deprecated. The URL of the avatar for this user. Max length is 2000 characters.
+ * @example https://atlassian.com/account/jane_doe/avatar/32
+ */
+ avatar?: string;
+ };
+ /**
+ * Format: int32
+ * @description The number of comments on the pull request
+ * @example 42
+ */
+ commentCount: number;
+ /**
+ * @description The name of the source branch of this PR. Max length is 255 characters.
+ * @example ISSUE-1-feature-branch
+ */
+ sourceBranch: string;
+ /**
+ * Format: url
+ * @description The url of the source branch of this PR. This is used to match this PR against the branch. Max length is 2000 characters.
+ * @example https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/branch/ISSUE-1-feature-branch
+ */
+ sourceBranchUrl?: string;
+ /**
+ * @description The most recent update to this PR. Formatted as a UTC ISO 8601 date time format.
+ * @example 2016-10-31T23:27:25+00:00
+ */
+ lastUpdate: string;
+ /**
+ * @description The name of destination branch of this PR. Max length is 255 characters.
+ * @example master
+ */
+ destinationBranch?: string;
+ /**
+ * Format: url
+ * @description The url of the destination branch of this PR. Max length is 2000 characters.
+ * @example https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/src/master
+ */
+ destinationBranchUrl?: string;
+ /** @description The list of reviewers of this pull request */
+ reviewers?: {
+ /**
+ * @description Deprecated. The name of this reviewer. Max length is 255 characters.
+ * @example Jane Doe
+ */
+ name?: string;
+ /**
+ * @description The approval status of this reviewer, default is UNAPPROVED.
+ * @example APPROVED
+ * @enum {string}
+ */
+ approvalStatus?: "APPROVED" | "NEEDSWORK" | "UNAPPROVED";
+ /**
+ * Format: url
+ * @description Deprecated. The URL of the profile for this reviewer. Max length is 2000 characters.
+ * @example https://atlassian.com/account/jane_doe
+ */
+ url?: string;
+ /**
+ * Format: url
+ * @description Deprecated. The URL of the avatar for this reviewer. Max length is 2000 characters.
+ * @example https://atlassian.com/account/jane_doe/avatar/32
+ */
+ avatar?: string;
+ /**
+ * @description The email address of this reviewer. Max length is 254 characters.
+ * @example jane_doe@example.com
+ */
+ email?: string;
+ /**
+ * @description The Atlassian Account ID (AAID) of this reviewer. Max length is 128 characters.
+ * @example 655363:e4ca5e2d-a901-40e3-877e-bf5d22c0f130
+ */
+ accountId?: string;
+ }[];
+ /**
+ * Format: url
+ * @description The URL of this pull request. Max length is 2000 characters.
+ * @example https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/pull-requests/2
+ */
+ url: string;
+ /**
+ * @description Shortened identifier for this pull request, used for display. Max length is 255 characters.
+ * @example Pull request 2
+ */
+ displayId: string;
+ /**
+ * Format: int32
+ * @description The number of tasks on the pull request
+ * @example 42
+ */
+ taskCount?: number;
+ }[];
+ /**
+ * Format: url
+ * @description The URL of the avatar for this repository. Max length is 2000 characters.
+ * @example http://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/avatar/32
+ */
+ avatar?: string;
+ /**
+ * @description Description of the avatar for this repository. Max length is 1024 characters.
+ * @example Avatar description
+ */
+ avatarDescription?: string;
+ /**
+ * @description The ID of this entity. Will be used for cross entity linking. Must be unique by entity type within a repository, i.e., only one commit can have ID 'X' in repository 'Y'. But adding, e.g., a branch with ID 'X' to repository 'Y' is acceptable. Only alphanumeric characters, and '~.-_', are allowed. Max length is 1024 characters.
+ * @example c6c7c750-cee2-48e2-b920-d7706dfd11f9
+ */
+ id: string;
+ /**
+ * Format: int64
+ * @description An ID used to apply an ordering to updates for this entity in the case of out-of-order receipt of update requests. This can be any monotonically increasing number. A suggested implementation is to use epoch millis from the provider system, but other alternatives are valid (e.g. a provider could store a counter against each entity and increment that on each update to Jira). Updates for an entity that are received with an updateSqeuenceId lower than what is currently stored will be ignored.
+ * @example 1523494301248
+ */
+ updateSequenceId: number;
+ }[];
+ /** @description Flag to prevent automatic issue transitions and smart commits being fired, default is false. */
+ preventTransitions?: boolean;
+ /**
+ * @description Indicates the operation being performed by the provider system when sending this data. "NORMAL" - Data received during normal operation (e.g. a user pushing a branch). "BACKFILL" - Data received while backfilling existing data (e.g. indexing a newly connected account). Default is "NORMAL". Please note that "BACKFILL" operations have a much higher rate-limiting threshold but are also processed slower in comparison to "NORMAL" operations.
+ * @example NORMAL
+ * @enum {string}
+ */
+ operationType?: "NORMAL" | "BACKFILL";
+ /** @description Arbitrary properties to tag the submitted repositories with. These properties can be used for delete operations to e.g. clean up all development information associated with an account in the event that the account is removed from the provider system. Note that these properties will never be returned with repository or entity data. They are not intended for use as metadata to associate with a repository. Maximum length of each key or value is 255 characters. Maximum allowed number of properties key/value pairs is 5. Properties keys cannot start with '_' character. Properties keys cannot contain ':' character. */
+ properties?: {
+ [key: string]: string;
+ };
+ /**
+ * ProviderMetadata
+ * @description Information about the provider. This is useful for auditing, logging, debugging, and other internal uses. It is not considered private information. Hence, it may not contain personally identifiable information.
+ */
+ providerMetadata?: {
+ /**
+ * @description An optional name of the source of the development information data.
+ * @example Bitbucket Server 6.7.2
+ */
+ product?: string;
+ };
+ };
+ };
+ };
+ responses: {
+ /** @description Submission accepted. Each submitted repository and entity that is of a valid format will be eventually available in Jira. */
+ 202: {
+ content: {
+ "application/json": {
+ /** @description The IDs of devinfo entities that have been accepted for submission grouped by their repository IDs. Note that a devinfo entity that isn't updated due to it's updateSequenceId being out of order is not considered a failed submission. */
+ acceptedDevinfoEntities?: {
+ [key: string]: {
+ /** @description Commits IDs */
+ commits?: string[];
+ /** @description Branch IDs */
+ branches?: string[];
+ /** @description Pull request IDs */
+ pullRequests?: string[];
+ };
+ };
+ /** @description IDs of devinfo entities that have not been accepted for submission and caused error descriptions, usually due to a problem with the request data. The entities (if present) will be grouped by their repository id and type. Entity IDs are listed with errors associated with that devinfo entity that have prevented it being submitted. */
+ failedDevinfoEntities?: {
+ [key: string]: {
+ /** @description Repository errors */
+ errorMessages?: {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ /** @description Commits errors */
+ commits?: {
+ /** @description Entity id */
+ id: string;
+ /** @description Error message */
+ errorMessages?: {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ }[];
+ /** @description Branches errors */
+ branches?: {
+ /** @description Entity id */
+ id: string;
+ /** @description Error message */
+ errorMessages?: {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ }[];
+ /** @description Pull requests errors */
+ pullRequests?: {
+ /** @description Entity id */
+ id: string;
+ /** @description Error message */
+ errorMessages?: {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ }[];
+ };
+ };
+ /** @description Issue keys that are not known on this Jira instance (if any). These may be invalid keys (e.g. `UTF-8` is sometimes incorrectly identified as a Jira issue key), or they may be for projects that no longer exist. If a devinfo entity has been associated with issue keys other than those in this array it will still be stored against those valid keys. */
+ unknownIssueKeys?: string[];
+ };
+ };
+ };
+ /** @description Request has incorrect format. It will fail in the following cases: If no repositories or development information entities were provided, or more than 5 properties were submitted, or there are one or more properties with leading underscore '_' symbol in their keys. */
+ 400: {
+ content: {
+ "application/json": {
+ /** @description List of errors occurred. */
+ errorMessages: {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ /** @description Missing a JWT token, or token is invalid. */
+ 401: {
+ content: never;
+ };
+ /** @description The JWT token used does not correspond to an app that defines the jiraDevelopmentTool module, or the app does not define the 'WRITE' scope */
+ 403: {
+ content: never;
+ };
+ /** @description Data is too large. Submit fewer devinfo entities in each payload. */
+ 413: {
+ content: {
+ "application/json": {
+ /** @description List of errors occurred. */
+ errorMessages: {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ /** @description API rate limit has been exceeded. */
+ 429: {
+ headers: {
+ /** @description The number of remaining possible requests in current rate limit window. */
+ "X-RateLimit-Remaining"?: number;
+ /** @description The date in ISO 8601 format when the rate limit values will be next reset. */
+ "X-RateLimit-Reset"?: string;
+ /** @description The maximum possible requests in a window of one minute. */
+ "X-RateLimit-Limit"?: number;
+ /** @description The number of seconds to wait before making a follow-up request. */
+ "Retry-After"?: number;
+ };
+ content: never;
+ };
+ /** @description An unknown error has occurred. */
+ 500: {
+ content: {
+ "application/json": {
+ /** @description List of errors occurred. */
+ errorMessages: {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ /** @description Service is unavailable due to maintenance or other reasons. */
+ 503: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Get repository
+ * @description For the specified repository ID, retrieves the repository and the most recent 400 development information entities. The result will be what is currently stored, ignoring any pending updates or deletes.
+ */
+ getRepository: {
+ parameters: {
+ header: {
+ /** @description All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that corresponds to an app installed in Jira. If the JWT token corresponds to a Connect app that does not define the jiraDevelopmentTool module it will be rejected with a 403. See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens. See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations. */
+ Authorization: string;
+ };
+ path: {
+ /** @description The ID of repository to fetch */
+ repositoryId: string;
+ };
+ };
+ responses: {
+ /** @description The repository data currently stored for the given ID. */
+ 200: {
+ content: {
+ "application/json": {
+ /**
+ * @description The name of this repository. Max length is 255 characters.
+ * @example atlassian-connect-jira-example
+ */
+ name: string;
+ /**
+ * @description Description of this repository. Max length is 1024 characters.
+ * @example The repository which stores code of the Atlassian Connect Add-on Devinfo application.
+ */
+ description?: string;
+ /**
+ * @description The ID of the repository this repository was forked from, if it's a fork. Max length is 1024 characters.
+ * @example 56c7c750-cee2-48e2-b920-d7706dfd11f7
+ */
+ forkOf?: string;
+ /**
+ * Format: url
+ * @description The URL of this repository. Max length is 2000 characters.
+ * @example https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example
+ */
+ url: string;
+ /** @description List of commits to update in this repository. Must not contain duplicate entity IDs. Maximum number of commits is 400 */
+ commits?: {
+ /**
+ * @description The identifier or hash of the commit. Will be used for cross entity linking. Must be unique for all commits within a repository, i.e., only one commit can have ID 'X' in repository 'Y'. But adding, e.g., a branch with ID 'X' to repository 'Y' is acceptable. Only alphanumeric characters, and '~.-_', are allowed. Max length is 1024 characters
+ * @example a7727ee6350c33cdf90826dc21abaa26a5704370
+ */
+ id: string;
+ /**
+ * @description List of issues keys that this entity is associated with. They must be valid Jira issue keys.
+ * @example ["ISSUE-1","TEST-2"]
+ */
+ issueKeys: string[];
+ /**
+ * Format: int64
+ * @description An ID used to apply an ordering to updates for this entity in the case of out-of-order receipt of update requests. This can be any monotonically increasing number. A suggested implementation is to use epoch millis from the provider system, but other alternatives are valid (e.g. a provider could store a counter against each entity and increment that on each update to Jira). Updates for an entity that are received with an updateSqeuenceId lower than what is currently stored will be ignored.
+ * @example 1523494301248
+ */
+ updateSequenceId: number;
+ /** @description Deprecated. Use the id field instead. */
+ hash?: string;
+ /**
+ * @description The set of flags for this commit
+ * @example [MERGE_COMMIT]
+ */
+ flags?: "MERGE_COMMIT"[];
+ /**
+ * @description The commit message. Max length is 1024 characters. If anything longer is supplied, it will be truncated down to 1024 characters.
+ * @example README.md edited online with Bitbucket
+ */
+ message: string;
+ /**
+ * Author
+ * @description Describes the author of a particular entity
+ */
+ author: {
+ /**
+ * @description Deprecated. The name of this user in a format suitable for display. Max length is 255 characters.
+ * @example Jane Doe
+ */
+ name?: string;
+ /**
+ * @description The email address of the user. Used to associate the user with a Jira user. Max length is 255 characters.
+ * @example jane_doe@atlassian.com
+ */
+ email?: string;
+ /**
+ * @description Deprecated. The username of the user. Used to associate the user with a Jira user if there are multiple users for a given email. Max length is 255 characters.
+ * @example jdoe
+ */
+ username?: string;
+ /**
+ * @description Deprecated. The URL of the profile for this user. Max length is 2000 characters.
+ * @example https://atlassian.com/account/jane_doe
+ */
+ url?: string;
+ /**
+ * @description Deprecated. The URL of the avatar for this user. Max length is 2000 characters.
+ * @example https://atlassian.com/account/jane_doe/avatar/32
+ */
+ avatar?: string;
+ };
+ /**
+ * Format: int32
+ * @description The total number of files added, removed, or modified by this commit
+ * @example 1
+ */
+ fileCount: number;
+ /**
+ * Format: url
+ * @description The URL of this commit. Max length is 2000 characters.
+ * @example https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/commits/a7727ee6350c33cdf90826dc21abaa26a5704370
+ */
+ url: string;
+ /** @description List of file changes. Max number of files is 10. Currently, only the first 5 files are shown (sorted by path) in the UI. This UI behavior may change without notice. */
+ files?: {
+ /**
+ * @description The path of the file. Max length is 1024 characters.
+ * @example /home/user/src/atlassian-connect-jira-example/README.md
+ */
+ path: string;
+ /**
+ * Format: url
+ * @description The URL of this file. Max length is 2000 characters.
+ * @example https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/src/a7727ee6350c33cdf90826dc21abaa26a5704370/README.md
+ */
+ url: string;
+ /**
+ * @description The operation performed on this file
+ * @example MODIFIED
+ * @enum {string}
+ */
+ changeType: "ADDED" | "COPIED" | "DELETED" | "MODIFIED" | "MOVED" | "UNKNOWN";
+ /**
+ * Format: int32
+ * @description Number of lines added to the file
+ * @example 0
+ */
+ linesAdded: number;
+ /**
+ * Format: int32
+ * @description Number of lines removed from the file
+ * @example 1
+ */
+ linesRemoved: number;
+ }[];
+ /**
+ * @description The author timestamp of this commit. Formatted as a UTC ISO 8601 date time format.
+ * @example 2016-10-31T23:27:25+00:00
+ */
+ authorTimestamp: string;
+ /**
+ * @description Shortened identifier for this commit, used for display. Max length is 255 characters.
+ * @example a7727ee
+ */
+ displayId: string;
+ }[];
+ /** @description List of branches to update in this repository. Must not contain duplicate entity IDs. Maximum number of branches is 400. */
+ branches?: {
+ /**
+ * @description The ID of this entity. Will be used for cross entity linking. Must be unique by entity type within a repository, i.e., only one commit can have ID 'X' in repository 'Y'. But adding, e.g., a branch with ID 'X' to repository 'Y' is acceptable. Only alphanumeric characters, and '~.-_', are allowed. Max length is 1024 characters.
+ * @example c6c7c750-cee2-48e2-b920-d7706dfd11f9
+ */
+ id: string;
+ /**
+ * @description List of issues keys that this entity is associated with. They must be valid Jira issue keys.
+ * @example ["ISSUE-1","TEST-2"]
+ */
+ issueKeys: string[];
+ /**
+ * Format: int64
+ * @description An ID used to apply an ordering to updates for this entity in the case of out-of-order receipt of update requests. This can be any monotonically increasing number. A suggested implementation is to use epoch millis from the provider system, but other alternatives are valid (e.g. a provider could store a counter against each entity and increment that on each update to Jira). Updates for an entity that are received with an updateSqeuenceId lower than what is currently stored will be ignored.
+ * @example 1523494301248
+ */
+ updateSequenceId: number;
+ /**
+ * @description The name of the branch. Max length is 512 characters.
+ * @example master
+ */
+ name: string;
+ /**
+ * Commit
+ * @description Represents a commit in the version control system.
+ */
+ lastCommit: {
+ /**
+ * @description The identifier or hash of the commit. Will be used for cross entity linking. Must be unique for all commits within a repository, i.e., only one commit can have ID 'X' in repository 'Y'. But adding, e.g., a branch with ID 'X' to repository 'Y' is acceptable. Only alphanumeric characters, and '~.-_', are allowed. Max length is 1024 characters
+ * @example a7727ee6350c33cdf90826dc21abaa26a5704370
+ */
+ id: string;
+ /**
+ * @description List of issues keys that this entity is associated with. They must be valid Jira issue keys.
+ * @example ["ISSUE-1","TEST-2"]
+ */
+ issueKeys: string[];
+ /**
+ * Format: int64
+ * @description An ID used to apply an ordering to updates for this entity in the case of out-of-order receipt of update requests. This can be any monotonically increasing number. A suggested implementation is to use epoch millis from the provider system, but other alternatives are valid (e.g. a provider could store a counter against each entity and increment that on each update to Jira). Updates for an entity that are received with an updateSqeuenceId lower than what is currently stored will be ignored.
+ * @example 1523494301248
+ */
+ updateSequenceId: number;
+ /** @description Deprecated. Use the id field instead. */
+ hash?: string;
+ /**
+ * @description The set of flags for this commit
+ * @example [MERGE_COMMIT]
+ */
+ flags?: "MERGE_COMMIT"[];
+ /**
+ * @description The commit message. Max length is 1024 characters. If anything longer is supplied, it will be truncated down to 1024 characters.
+ * @example README.md edited online with Bitbucket
+ */
+ message: string;
+ /**
+ * Author
+ * @description Describes the author of a particular entity
+ */
+ author: {
+ /**
+ * @description Deprecated. The name of this user in a format suitable for display. Max length is 255 characters.
+ * @example Jane Doe
+ */
+ name?: string;
+ /**
+ * @description The email address of the user. Used to associate the user with a Jira user. Max length is 255 characters.
+ * @example jane_doe@atlassian.com
+ */
+ email?: string;
+ /**
+ * @description Deprecated. The username of the user. Used to associate the user with a Jira user if there are multiple users for a given email. Max length is 255 characters.
+ * @example jdoe
+ */
+ username?: string;
+ /**
+ * @description Deprecated. The URL of the profile for this user. Max length is 2000 characters.
+ * @example https://atlassian.com/account/jane_doe
+ */
+ url?: string;
+ /**
+ * @description Deprecated. The URL of the avatar for this user. Max length is 2000 characters.
+ * @example https://atlassian.com/account/jane_doe/avatar/32
+ */
+ avatar?: string;
+ };
+ /**
+ * Format: int32
+ * @description The total number of files added, removed, or modified by this commit
+ * @example 1
+ */
+ fileCount: number;
+ /**
+ * Format: url
+ * @description The URL of this commit. Max length is 2000 characters.
+ * @example https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/commits/a7727ee6350c33cdf90826dc21abaa26a5704370
+ */
+ url: string;
+ /** @description List of file changes. Max number of files is 10. Currently, only the first 5 files are shown (sorted by path) in the UI. This UI behavior may change without notice. */
+ files?: {
+ /**
+ * @description The path of the file. Max length is 1024 characters.
+ * @example /home/user/src/atlassian-connect-jira-example/README.md
+ */
+ path: string;
+ /**
+ * Format: url
+ * @description The URL of this file. Max length is 2000 characters.
+ * @example https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/src/a7727ee6350c33cdf90826dc21abaa26a5704370/README.md
+ */
+ url: string;
+ /**
+ * @description The operation performed on this file
+ * @example MODIFIED
+ * @enum {string}
+ */
+ changeType: "ADDED" | "COPIED" | "DELETED" | "MODIFIED" | "MOVED" | "UNKNOWN";
+ /**
+ * Format: int32
+ * @description Number of lines added to the file
+ * @example 0
+ */
+ linesAdded: number;
+ /**
+ * Format: int32
+ * @description Number of lines removed from the file
+ * @example 1
+ */
+ linesRemoved: number;
+ }[];
+ /**
+ * @description The author timestamp of this commit. Formatted as a UTC ISO 8601 date time format.
+ * @example 2016-10-31T23:27:25+00:00
+ */
+ authorTimestamp: string;
+ /**
+ * @description Shortened identifier for this commit, used for display. Max length is 255 characters.
+ * @example a7727ee
+ */
+ displayId: string;
+ };
+ /**
+ * @description The URL of the page for creating a pull request from this branch. Max length is 2000 characters.
+ * @example https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/pull-requests/new
+ */
+ createPullRequestUrl?: string;
+ /**
+ * @description The URL of the branch. Max length is 2000 characters.
+ * @example https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/branch/master
+ */
+ url: string;
+ }[];
+ /** @description List of pull requests to update in this repository. Must not contain duplicate entity IDs. Maximum number of pull requests is 400 */
+ pullRequests?: {
+ /**
+ * @description The ID of this entity. Will be used for cross entity linking. Must be unique by entity type within a repository, i.e., only one commit can have ID 'X' in repository 'Y'. But adding, e.g., a branch with ID 'X' to repository 'Y' is acceptable. Only alphanumeric characters, and '~.-_', are allowed. Max length is 1024 characters
+ * @example c6c7c750-cee2-48e2-b920-d7706dfd11f9
+ */
+ id: string;
+ /**
+ * @description List of issues keys that this entity is associated with. They must be valid Jira issue keys.
+ * @example ["ISSUE-1","TEST-2"]
+ */
+ issueKeys: string[];
+ /**
+ * Format: int64
+ * @description An ID used to apply an ordering to updates for this entity in the case of out-of-order receipt of update requests. This can be any monotonically increasing number. A suggested implementation is to use epoch millis from the provider system, but other alternatives are valid (e.g. a provider could store a counter against each entity and increment that on each update to Jira). Updates for an entity that are received with an updateSqeuenceId lower than what is currently stored will be ignored.
+ * @example 1523494301248
+ */
+ updateSequenceId: number;
+ /**
+ * @description The status of the pull request. In the case of concurrent updates, priority is given in the order OPEN, MERGED, DECLINED, DRAFT, UNKNOWN
+ * @example OPEN
+ * @enum {string}
+ */
+ status: "OPEN" | "MERGED" | "DECLINED" | "DRAFT" | "UNKNOWN";
+ /**
+ * @description Title of the pull request. Max length is 1024 characters.
+ * @example Pull request 2, fixing all the issues caused by pull request #1
+ */
+ title: string;
+ /**
+ * Author
+ * @description Describes the author of a particular entity
+ */
+ author: {
+ /**
+ * @description Deprecated. The name of this user in a format suitable for display. Max length is 255 characters.
+ * @example Jane Doe
+ */
+ name?: string;
+ /**
+ * @description The email address of the user. Used to associate the user with a Jira user. Max length is 255 characters.
+ * @example jane_doe@atlassian.com
+ */
+ email?: string;
+ /**
+ * @description Deprecated. The username of the user. Used to associate the user with a Jira user if there are multiple users for a given email. Max length is 255 characters.
+ * @example jdoe
+ */
+ username?: string;
+ /**
+ * @description Deprecated. The URL of the profile for this user. Max length is 2000 characters.
+ * @example https://atlassian.com/account/jane_doe
+ */
+ url?: string;
+ /**
+ * @description Deprecated. The URL of the avatar for this user. Max length is 2000 characters.
+ * @example https://atlassian.com/account/jane_doe/avatar/32
+ */
+ avatar?: string;
+ };
+ /**
+ * Format: int32
+ * @description The number of comments on the pull request
+ * @example 42
+ */
+ commentCount: number;
+ /**
+ * @description The name of the source branch of this PR. Max length is 255 characters.
+ * @example ISSUE-1-feature-branch
+ */
+ sourceBranch: string;
+ /**
+ * Format: url
+ * @description The url of the source branch of this PR. This is used to match this PR against the branch. Max length is 2000 characters.
+ * @example https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/branch/ISSUE-1-feature-branch
+ */
+ sourceBranchUrl?: string;
+ /**
+ * @description The most recent update to this PR. Formatted as a UTC ISO 8601 date time format.
+ * @example 2016-10-31T23:27:25+00:00
+ */
+ lastUpdate: string;
+ /**
+ * @description The name of destination branch of this PR. Max length is 255 characters.
+ * @example master
+ */
+ destinationBranch?: string;
+ /**
+ * Format: url
+ * @description The url of the destination branch of this PR. Max length is 2000 characters.
+ * @example https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/src/master
+ */
+ destinationBranchUrl?: string;
+ /** @description The list of reviewers of this pull request */
+ reviewers?: {
+ /**
+ * @description Deprecated. The name of this reviewer. Max length is 255 characters.
+ * @example Jane Doe
+ */
+ name?: string;
+ /**
+ * @description The approval status of this reviewer, default is UNAPPROVED.
+ * @example APPROVED
+ * @enum {string}
+ */
+ approvalStatus?: "APPROVED" | "NEEDSWORK" | "UNAPPROVED";
+ /**
+ * Format: url
+ * @description Deprecated. The URL of the profile for this reviewer. Max length is 2000 characters.
+ * @example https://atlassian.com/account/jane_doe
+ */
+ url?: string;
+ /**
+ * Format: url
+ * @description Deprecated. The URL of the avatar for this reviewer. Max length is 2000 characters.
+ * @example https://atlassian.com/account/jane_doe/avatar/32
+ */
+ avatar?: string;
+ /**
+ * @description The email address of this reviewer. Max length is 254 characters.
+ * @example jane_doe@example.com
+ */
+ email?: string;
+ /**
+ * @description The Atlassian Account ID (AAID) of this reviewer. Max length is 128 characters.
+ * @example 655363:e4ca5e2d-a901-40e3-877e-bf5d22c0f130
+ */
+ accountId?: string;
+ }[];
+ /**
+ * Format: url
+ * @description The URL of this pull request. Max length is 2000 characters.
+ * @example https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/pull-requests/2
+ */
+ url: string;
+ /**
+ * @description Shortened identifier for this pull request, used for display. Max length is 255 characters.
+ * @example Pull request 2
+ */
+ displayId: string;
+ /**
+ * Format: int32
+ * @description The number of tasks on the pull request
+ * @example 42
+ */
+ taskCount?: number;
+ }[];
+ /**
+ * Format: url
+ * @description The URL of the avatar for this repository. Max length is 2000 characters.
+ * @example http://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/avatar/32
+ */
+ avatar?: string;
+ /**
+ * @description Description of the avatar for this repository. Max length is 1024 characters.
+ * @example Avatar description
+ */
+ avatarDescription?: string;
+ /**
+ * @description The ID of this entity. Will be used for cross entity linking. Must be unique by entity type within a repository, i.e., only one commit can have ID 'X' in repository 'Y'. But adding, e.g., a branch with ID 'X' to repository 'Y' is acceptable. Only alphanumeric characters, and '~.-_', are allowed. Max length is 1024 characters.
+ * @example c6c7c750-cee2-48e2-b920-d7706dfd11f9
+ */
+ id: string;
+ /**
+ * Format: int64
+ * @description An ID used to apply an ordering to updates for this entity in the case of out-of-order receipt of update requests. This can be any monotonically increasing number. A suggested implementation is to use epoch millis from the provider system, but other alternatives are valid (e.g. a provider could store a counter against each entity and increment that on each update to Jira). Updates for an entity that are received with an updateSqeuenceId lower than what is currently stored will be ignored.
+ * @example 1523494301248
+ */
+ updateSequenceId: number;
+ };
+ };
+ };
+ /** @description Missing a JWT token, or token is invalid. */
+ 401: {
+ content: never;
+ };
+ /** @description The JWT token used does not correspond to an app that defines the jiraDevelopmentTool module, or the app does not define the 'READ' scope */
+ 403: {
+ content: never;
+ };
+ /** @description No data found for the given repository ID. */
+ 404: {
+ content: never;
+ };
+ /** @description API rate limit has been exceeded. */
+ 429: {
+ content: never;
+ };
+ /** @description An unknown error has occurred. */
+ 500: {
+ content: {
+ "application/json": {
+ /** @description List of errors occurred. */
+ errorMessages: {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ /** @description Service is unavailable due to maintenance or other reasons. */
+ 503: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Delete repository
+ * @description Deletes the repository data stored by the given ID and all related development information entities. Deletion is performed asynchronously.
+ */
+ deleteRepository: {
+ parameters: {
+ query?: {
+ /** @description An optional property to use to control deletion. Only stored data with an updateSequenceId less than or equal to that provided will be deleted. This can be used to help ensure submit/delete requests are applied correctly if they are issued close together. */
+ _updateSequenceId?: number;
+ };
+ header: {
+ /** @description All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that corresponds to an app installed in Jira. If the JWT token corresponds to a Connect app that does not define the jiraDevelopmentTool module it will be rejected with a 403. See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens. See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations. */
+ Authorization: string;
+ };
+ path: {
+ /** @description The ID of repository to delete */
+ repositoryId: string;
+ };
+ };
+ responses: {
+ /** @description Delete request has been accepted. Data will eventually be removed from Jira if it exists. */
+ 202: {
+ content: never;
+ };
+ /** @description Missing a JWT token, or token is invalid. */
+ 401: {
+ content: never;
+ };
+ /** @description The JWT token used does not correspond to an app that defines the jiraDevelopmentTool module, or the app does not define the 'DELETE' scope */
+ 403: {
+ content: never;
+ };
+ /** @description API rate limit has been exceeded. */
+ 429: {
+ content: never;
+ };
+ /** @description An unknown error has occurred. */
+ 500: {
+ content: {
+ "application/json": {
+ /** @description List of errors occurred. */
+ errorMessages: {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ /** @description Service is unavailable due to maintenance or other reasons. */
+ 503: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Delete development information by properties
+ * @description Deletes development information entities which have all the provided properties. Entities will be deleted that match ALL of the properties (i.e. treated as an AND). For example if request is `DELETE bulk?accountId=123&projectId=ABC` entities which have properties `accountId=123` and `projectId=ABC` will be deleted. Special property `_updateSequenceId` can be used to delete all entities with updateSequenceId less or equal than the value specified. In addition to the optional `_updateSequenceId`, one or more query params must be supplied to specify properties to delete by. Deletion is performed asynchronously: specified entities will eventually be removed from Jira.
+ */
+ deleteByProperties: {
+ parameters: {
+ query?: {
+ /** @description An optional property to use to control deletion. Only stored data with an updateSequenceId less than or equal to that provided will be deleted. This can be used to help ensure submit/delete requests are applied correctly if they are issued close together. */
+ _updateSequenceId?: number;
+ };
+ header: {
+ /** @description All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that corresponds to an app installed in Jira. If the JWT token corresponds to a Connect app that does not define the jiraDevelopmentTool module it will be rejected with a 403. See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens. See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations. */
+ Authorization: string;
+ };
+ };
+ responses: {
+ /** @description Delete accepted. Data will eventually be removed from Jira. */
+ 202: {
+ content: never;
+ };
+ /** @description Request has incorrect format. It will fail in the following cases: If no query properties are specified. If `_updateSequenceId` is not a numeric value. If multiple values of the same property key are specified. Deleting data for many property values, for the same property key, requires multiple requests to this resource. */
+ 400: {
+ content: {
+ "application/json": {
+ /** @description List of errors occurred. */
+ errorMessages: {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ /** @description Missing a JWT token, or token is invalid. */
+ 401: {
+ content: never;
+ };
+ /** @description The JWT token used does not correspond to an app that defines the jiraDevelopmentTool module, or the app does not define the 'DELETE' scope */
+ 403: {
+ content: never;
+ };
+ /** @description API rate limit has been exceeded. */
+ 429: {
+ content: never;
+ };
+ /** @description An unknown error has occurred. */
+ 500: {
+ content: {
+ "application/json": {
+ /** @description List of errors occurred. */
+ errorMessages: {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ /** @description Service is unavailable due to maintenance or other reasons. */
+ 503: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Check if data exists for the supplied properties
+ * @description Checks if development information which have all the provided properties exists. For example, if request is `GET existsByProperties?accountId=123&projectId=ABC` then result will be positive only if there is at least one entity or repository with both properties `accountId=123` and `projectId=ABC`. Special property `_updateSequenceId` can be used to filter all entities with updateSequenceId less or equal than the value specified. In addition to the optional `_updateSequenceId`, one or more query params must be supplied to specify properties to search by.
+ */
+ existsByProperties: {
+ parameters: {
+ query?: {
+ /** @description An optional property. Filters out entities and repositories which have updateSequenceId greater than specified. */
+ _updateSequenceId?: number;
+ };
+ header: {
+ /** @description All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that corresponds to an app installed in Jira. If the JWT token corresponds to a Connect app that does not define the jiraDevelopmentTool module it will be rejected with a 403. See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens. See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations. */
+ Authorization: string;
+ };
+ };
+ responses: {
+ /** @description Returns whether data exists for the specified properties. */
+ 200: {
+ content: {
+ "application/json": {
+ /** @description Whether there is data matching the query */
+ hasDataMatchingProperties?: boolean;
+ };
+ };
+ };
+ /** @description Request has incorrect format. It will fail in the following cases: If no query properties are specified. If `_updateSequenceId` is not a numeric value. If multiple values of the same property key are specified. */
+ 400: {
+ content: {
+ "application/json": {
+ /** @description List of errors occurred. */
+ errorMessages: {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ /** @description Missing a JWT token, or token is invalid. */
+ 401: {
+ content: never;
+ };
+ /** @description The JWT token used does not correspond to an app that defines the jiraDevelopmentTool module, or the app does not define the 'READ' scope */
+ 403: {
+ content: never;
+ };
+ /** @description API rate limit has been exceeded. */
+ 429: {
+ content: never;
+ };
+ /** @description An unknown error has occurred. */
+ 500: {
+ content: {
+ "application/json": {
+ /** @description List of errors occurred. */
+ errorMessages: {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ /** @description Service is unavailable due to maintenance or other reasons. */
+ 503: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Delete development information entity
+ * @description Deletes particular development information entity. Deletion is performed asynchronously.
+ */
+ deleteEntity: {
+ parameters: {
+ query?: {
+ /** @description An optional property to use to control deletion. Only stored data with an updateSequenceId less than or equal to that provided will be deleted. This can be used to help ensure submit/delete requests are applied correctly if they are issued close together. */
+ _updateSequenceId?: number;
+ };
+ header: {
+ /** @description All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that corresponds to an app installed in Jira. If the JWT token corresponds to a Connect app that does not define the jiraDevelopmentTool module it will be rejected with a 403. See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens. See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations. */
+ Authorization: string;
+ };
+ path: {
+ repositoryId: string;
+ entityType: "commit" | "branch" | "pull_request";
+ entityId: string;
+ };
+ };
+ responses: {
+ /** @description Delete request has been accepted. Data will eventually be removed from Jira if it exists. */
+ 202: {
+ content: never;
+ };
+ /** @description Wrong entity type specified */
+ 400: {
+ content: {
+ "application/json": {
+ /** @description List of errors occurred. */
+ errorMessages: {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ /** @description Missing a JWT token, or token is invalid. */
+ 401: {
+ content: never;
+ };
+ /** @description The JWT token used does not correspond to an app that defines the jiraDevelopmentTool module, or the app does not define the 'DELETE' scope */
+ 403: {
+ content: never;
+ };
+ /** @description API rate limit has been exceeded. */
+ 429: {
+ content: never;
+ };
+ /** @description An unknown error has occurred. */
+ 500: {
+ content: {
+ "application/json": {
+ /** @description List of errors occurred. */
+ errorMessages: {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ /** @description Service is unavailable due to maintenance or other reasons. */
+ 503: {
+ content: never;
+ };
+ };
+ };
+ /**
+ * Submit Feature Flag data
+ * @description Update / insert Feature Flag data.
+ *
+ * Feature Flags are identified by their ID, and existing Feature Flag data for the same ID will be replaced if it exists and the updateSequenceId of existing data is less than the incoming data.
+ *
+ * Submissions are performed asynchronously. Submitted data will eventually be available in Jira; most updates are available within a short period of time, but may take some time during peak load and/or maintenance times. The getFeatureFlagById operation can be used to confirm that data has been stored successfully (if needed).
+ *
+ * In the case of multiple Feature Flags being submitted in one request, each is validated individually prior to submission. Details of which Feature Flags failed submission (if any) are available in the response object.
+ *
+ * Only Connect apps that define the `jiraFeatureFlagInfoProvider` module can access this resource.
+ * This resource requires the 'WRITE' scope for Connect apps.
+ */
+ submitFeatureFlags: {
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with a Connect JWT token that corresponds to the Provider app installed in Jira.
+ *
+ * If the JWT token corresponds to an app that does not define Feature Flags module it will be rejected with a 403.
+ *
+ * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details.
+ */
+ Authorization: string;
+ };
+ };
+ /** @description Feature Flag data to submit. */
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * Properties
+ * @description Properties assigned to Feature Flag data that can then be used for delete / query operations.
+ *
+ * Examples might be an account or user ID that can then be used to clean up data if an account is removed from the Provider system.
+ *
+ * Note that these properties will never be returned with Feature Flag data. They are not intended for use as metadata to associate with a Feature Flag. Internally they are stored as a hash so that personal information etc. is never stored within Jira.
+ *
+ * Properties are supplied as key/value pairs, a maximum of 5 properties can be supplied, and keys must not contain ':' or start with '_'.
+ *
+ * @example {
+ * "accountId": "account-234",
+ * "projectId": "project-123"
+ * }
+ */
+ properties?: {
+ [key: string]: string;
+ };
+ /**
+ * @description A list of Feature Flags to submit to Jira.
+ *
+ * Each Feature Flag may be associated with 1 or more Jira issue keys, and will be associated with any properties included in this request.
+ */
+ flags: {
+ /**
+ * @description The FeatureFlagData schema version used for this flag data.
+ *
+ * Placeholder to support potential schema changes in the future.
+ *
+ * @default 1.0
+ * @example 1.0
+ * @enum {string}
+ */
+ schemaVersion?: "1.0";
+ /**
+ * @description The identifier for the Feature Flag. Must be unique for a given Provider.
+ *
+ * @example 111-222-333
+ */
+ id: string;
+ /**
+ * @description The identifier that users would use to reference the Feature Flag in their source code etc.
+ *
+ * Will be made available via the UI for users to copy into their source code etc.
+ *
+ * @example my-awesome-feature
+ */
+ key: string;
+ /**
+ * Format: int64
+ * @description An ID used to apply an ordering to updates for this Feature Flag in the case of out-of-order receipt of update requests.
+ *
+ * This can be any monotonically increasing number. A suggested implementation is to use epoch millis from the Provider system, but other alternatives are valid (e.g. a Provider could store a counter against each Feature Flag and increment that on each update to Jira).
+ *
+ * Updates for a Feature Flag that are received with an updateSqeuenceId lower than what is currently stored will be ignored.
+ *
+ * @example 1523494301448
+ */
+ updateSequenceId: number;
+ /**
+ * @description The human-readable name for the Feature Flag. Will be shown in the UI.
+ *
+ * If not provided, will use the ID for display.
+ *
+ * @example Enable awesome feature
+ */
+ displayName?: string;
+ /** @description The Jira issue keys to associate the Feature Flag information with. */
+ issueKeys: string[];
+ /**
+ * FeatureFlagSummary
+ * @description Summary information for a single Feature Flag.
+ *
+ * Providers may elect to provide information from a specific environment, or they may choose to 'roll up' information from across multiple environments - whatever makes most sense in the Provider system.
+ *
+ * This is the summary information that will be presented to the user on e.g. the Jira issue screen.
+ */
+ summary: {
+ /**
+ * Format: uri
+ * @description A URL users can use to link to a summary view of this flag, if appropriate.
+ *
+ * This could be any location that makes sense in the Provider system (e.g. if the summary information comes from a specific environment, it might make sense to link the user to the flag in that environment).
+ *
+ * @example https://example.com/project/feature-123/summary
+ */
+ url?: string;
+ /**
+ * FeatureFlagStatus
+ * @description Status information about a single Feature Flag.
+ */
+ status: {
+ /**
+ * @description Whether the Feature Flag is enabled in the given environment (or in summary).
+ *
+ * Enabled may imply a partial rollout, which can be described using the 'rollout' field.
+ */
+ enabled: boolean;
+ /**
+ * @description The value served by this Feature Flag when it is disabled. This could be the actual value or an alias, as appropriate.
+ *
+ * This value may be presented to the user in the UI.
+ *
+ * @example Disabled
+ */
+ defaultValue?: string;
+ /**
+ * FeatureFlagRollout
+ * @description Information about the rollout of a Feature Flag in an environment (or in summary).
+ *
+ * Only one of 'percentage', 'text', or 'rules' should be provided. They will be used in that order if multiple are present.
+ *
+ * This information may be presented to the user in the UI.
+ *
+ * @example {
+ * "percentage": 80
+ * }
+ */
+ rollout?: {
+ /** @description If the Feature Flag rollout is a simple percentage rollout */
+ percentage?: number;
+ /** @description A text status to display that represents the rollout. This could be e.g. a named cohort. */
+ text?: string;
+ /** @description A count of the number of rules active for this Feature Flag in an environment. */
+ rules?: number;
+ };
+ };
+ /**
+ * Format: date-time
+ * @description The last-updated timestamp to present to the user as a summary of the state of the Feature Flag.
+ *
+ * Providers may choose to supply the last-updated timestamp from a specific environment, or the 'most recent' last-updated timestamp across all environments - whatever makes sense in the Provider system.
+ *
+ * Expected format is an RFC3339 formatted string.
+ *
+ * @example 2018-01-20T23:27:25.000Z
+ */
+ lastUpdated: string;
+ };
+ /**
+ * @description Detail information for this Feature Flag.
+ *
+ * This may be information for each environment the Feature Flag is defined in or a selection of environments made by the user, as appropriate.
+ */
+ details: {
+ /**
+ * Format: uri
+ * @description A URL users can use to link to this Feature Flag, in this environment.
+ *
+ * @example https://example.com/project/feature-123/production
+ */
+ url: string;
+ /**
+ * Format: date-time
+ * @description The last-updated timestamp for this Feature Flag, in this environment.
+ *
+ * Expected format is an RFC3339 formatted string.
+ *
+ * @example 2018-01-20T23:27:25.000Z
+ */
+ lastUpdated: string;
+ /**
+ * EnvironmentDetails
+ * @description Details of a single environment.
+ *
+ * At the simplest this must be the name of the environment.
+ *
+ * Ideally there is also type information which may be used to group data from multiple Feature Flags and other entities for visualisation in the UI.
+ *
+ * @example {
+ * "name": "prod-us-west",
+ * "type": "production"
+ * }
+ */
+ environment: {
+ /** @description The name of the environment. */
+ name: string;
+ /**
+ * @description The 'type' or 'category' of environment this environment belongs to.
+ * @enum {string}
+ */
+ type?: "development" | "testing" | "staging" | "production";
+ };
+ /**
+ * FeatureFlagStatus
+ * @description Status information about a single Feature Flag.
+ */
+ status: {
+ /**
+ * @description Whether the Feature Flag is enabled in the given environment (or in summary).
+ *
+ * Enabled may imply a partial rollout, which can be described using the 'rollout' field.
+ */
+ enabled: boolean;
+ /**
+ * @description The value served by this Feature Flag when it is disabled. This could be the actual value or an alias, as appropriate.
+ *
+ * This value may be presented to the user in the UI.
+ *
+ * @example Disabled
+ */
+ defaultValue?: string;
+ /**
+ * FeatureFlagRollout
+ * @description Information about the rollout of a Feature Flag in an environment (or in summary).
+ *
+ * Only one of 'percentage', 'text', or 'rules' should be provided. They will be used in that order if multiple are present.
+ *
+ * This information may be presented to the user in the UI.
+ *
+ * @example {
+ * "percentage": 80
+ * }
+ */
+ rollout?: {
+ /** @description If the Feature Flag rollout is a simple percentage rollout */
+ percentage?: number;
+ /** @description A text status to display that represents the rollout. This could be e.g. a named cohort. */
+ text?: string;
+ /** @description A count of the number of rules active for this Feature Flag in an environment. */
+ rules?: number;
+ };
+ };
+ }[];
+ }[];
+ /**
+ * ProviderMetadata
+ * @description Information about the provider. This is useful for auditing, logging, debugging,
+ * and other internal uses. It is not considered private information. Hence, it may not contain personally
+ * identifiable information.
+ */
+ providerMetadata?: {
+ /**
+ * @description An optional name of the source of the feature flags.
+ * @example Atlassian Release Platform 2.1.0
+ */
+ product?: string;
+ };
+ };
+ };
+ };
+ responses: {
+ /**
+ * @description Submission accepted. Each submitted Feature Flag that is of a valid format will be eventually available in Jira.
+ *
+ * Details of which Feature Flags were submitted and which failed submission (due to data format problems etc.) are available in the response object.
+ */
+ 202: {
+ content: {
+ "application/json": {
+ /**
+ * @description The IDs of Feature Flags that have been accepted for submission.
+ *
+ * A Feature Flag may be rejected if it was only associated with unknown issue keys.
+ *
+ * Note that a Feature Flag that isn't updated due to it's updateSequenceId being out of order is not considered a failed submission.
+ *
+ * @example [
+ * "111-222-333",
+ * "444-555-666"
+ * ]
+ */
+ acceptedFeatureFlags?: string[];
+ /**
+ * @description Details of Feature Flags that have not been accepted for submission, usually due to a problem with the request data.
+ *
+ * The object (if present) will be keyed by Feature Flag ID and include any errors associated with that Feature Flag that have prevented it being submitted.
+ */
+ failedFeatureFlags?: {
+ [key: string]: {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ /**
+ * @description Issue keys that are not known on this Jira instance (if any).
+ *
+ * These may be invalid keys (e.g. `UTF-8` is sometimes incorrectly identified as a Jira issue key), or they may be for projects that no longer exist.
+ *
+ * If a Feature Flag has been associated with issue keys other than those in this array it will still be stored against those valid keys.
+ * If a Feature Flag was only associated with issue keys deemed to be invalid it won't be persisted.
+ */
+ unknownIssueKeys?: string[];
+ };
+ };
+ };
+ /**
+ * @description Request has incorrect format.
+ *
+ * Note that in the case of an individual Feature Flag having an invalid format (rather than the request as a whole) the response for the request will be a 202 and details of the invalid Feature Flag will be contained in the response object.
+ */
+ 400: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ /** @description Missing a JWT token, or token is invalid. */
+ 401: {
+ content: never;
+ };
+ /**
+ * @description The JWT token used does not correspond to an app that defines the Feature Flags module,
+ * or the app does not define the 'WRITE' scope.
+ */
+ 403: {
+ content: never;
+ };
+ /** @description Data is too large. Submit fewer Feature Flags in each payload. */
+ 413: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ /** @description API rate limit has been exceeded. */
+ 429: {
+ content: never;
+ };
+ /** @description Service is unavailable due to maintenance or other reasons. */
+ 503: {
+ content: never;
+ };
+ /** @description An unknown error has occurred. */
+ default: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ };
+ /**
+ * Delete Feature Flags by Property
+ * @description Bulk delete all Feature Flags that match the given request.
+ *
+ * One or more query params must be supplied to specify Properties to delete by. Optional param `_updateSequenceId` is no longer supported.
+ * If more than one Property is provided, data will be deleted that matches ALL of the Properties (e.g. treated as an AND).
+ * See the documentation for the submitFeatureFlags operation for more details.
+ *
+ * e.g. DELETE /bulkByProperties?accountId=account-123&createdBy=user-456
+ *
+ * Deletion is performed asynchronously. The getFeatureFlagById operation can be used to confirm that data has been deleted successfully (if needed).
+ *
+ * Only Connect apps that define the `jiraFeatureFlagInfoProvider` module can access this resource.
+ * This resource requires the 'DELETE' scope for Connect apps.
+ */
+ deleteFeatureFlagsByProperty: {
+ parameters: {
+ query?: {
+ /**
+ * @deprecated
+ * @description This parameter usage is no longer supported.
+ *
+ * An optional `_updateSequenceId` to use to control deletion.
+ *
+ * Only stored data with an `updateSequenceId` less than or equal to that provided will be deleted.
+ * This can be used help ensure submit/delete requests are applied correctly if issued close together.
+ *
+ * If not provided, all stored data that matches the request will be deleted.
+ */
+ _updateSequenceId?: number;
+ };
+ header: {
+ /**
+ * @description All requests must be signed with a Connect JWT token that corresponds to the Provider app installed in Jira.
+ *
+ * If the JWT token corresponds to an app that does not define Feature Flags module it will be rejected with a 403.
+ *
+ * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details.
+ */
+ Authorization: string;
+ };
+ };
+ responses: {
+ /** @description Delete accepted. Data will eventually be removed from Jira. */
+ 202: {
+ content: never;
+ };
+ /** @description Request has incorrect format (e.g. missing at least one Property param). */
+ 400: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ /** @description Missing a JWT token, or token is invalid. */
+ 401: {
+ content: never;
+ };
+ /**
+ * @description The JWT token used does not correspond to an app that defines the Feature Flags module,
+ * or the app does not define the 'DELETE' scope.
+ */
+ 403: {
+ content: never;
+ };
+ /** @description API rate limit has been exceeded. */
+ 429: {
+ content: never;
+ };
+ /** @description Service is unavailable due to maintenance or other reasons. */
+ 503: {
+ content: never;
+ };
+ /** @description An unknown error has occurred. */
+ default: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ };
+ /**
+ * Get a Feature Flag by ID
+ * @description Retrieve the currently stored Feature Flag data for the given ID.
+ *
+ * The result will be what is currently stored, ignoring any pending updates or deletes.
+ *
+ * Only Connect apps that define the `jiraFeatureFlagInfoProvider` module can access this resource.
+ * This resource requires the 'READ' scope for Connect apps.
+ */
+ getFeatureFlagById: {
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with a Connect JWT token that corresponds to the Provider app installed in Jira.
+ *
+ * If the JWT token corresponds to an app that does not define Feature Flags module it will be rejected with a 403.
+ *
+ * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details.
+ */
+ Authorization: string;
+ };
+ path: {
+ /** @description The ID of the Feature Flag to fetch. */
+ featureFlagId: string;
+ };
+ };
+ responses: {
+ /** @description The Feature Flag data currently stored for the given ID. */
+ 200: {
+ content: {
+ "application/json": {
+ /**
+ * @description The FeatureFlagData schema version used for this flag data.
+ *
+ * Placeholder to support potential schema changes in the future.
+ *
+ * @default 1.0
+ * @example 1.0
+ * @enum {string}
+ */
+ schemaVersion?: "1.0";
+ /**
+ * @description The identifier for the Feature Flag. Must be unique for a given Provider.
+ *
+ * @example 111-222-333
+ */
+ id: string;
+ /**
+ * @description The identifier that users would use to reference the Feature Flag in their source code etc.
+ *
+ * Will be made available via the UI for users to copy into their source code etc.
+ *
+ * @example my-awesome-feature
+ */
+ key: string;
+ /**
+ * Format: int64
+ * @description An ID used to apply an ordering to updates for this Feature Flag in the case of out-of-order receipt of update requests.
+ *
+ * This can be any monotonically increasing number. A suggested implementation is to use epoch millis from the Provider system, but other alternatives are valid (e.g. a Provider could store a counter against each Feature Flag and increment that on each update to Jira).
+ *
+ * Updates for a Feature Flag that are received with an updateSqeuenceId lower than what is currently stored will be ignored.
+ *
+ * @example 1523494301448
+ */
+ updateSequenceId: number;
+ /**
+ * @description The human-readable name for the Feature Flag. Will be shown in the UI.
+ *
+ * If not provided, will use the ID for display.
+ *
+ * @example Enable awesome feature
+ */
+ displayName?: string;
+ /** @description The Jira issue keys to associate the Feature Flag information with. */
+ issueKeys: string[];
+ /**
+ * FeatureFlagSummary
+ * @description Summary information for a single Feature Flag.
+ *
+ * Providers may elect to provide information from a specific environment, or they may choose to 'roll up' information from across multiple environments - whatever makes most sense in the Provider system.
+ *
+ * This is the summary information that will be presented to the user on e.g. the Jira issue screen.
+ */
+ summary: {
+ /**
+ * Format: uri
+ * @description A URL users can use to link to a summary view of this flag, if appropriate.
+ *
+ * This could be any location that makes sense in the Provider system (e.g. if the summary information comes from a specific environment, it might make sense to link the user to the flag in that environment).
+ *
+ * @example https://example.com/project/feature-123/summary
+ */
+ url?: string;
+ /**
+ * FeatureFlagStatus
+ * @description Status information about a single Feature Flag.
+ */
+ status: {
+ /**
+ * @description Whether the Feature Flag is enabled in the given environment (or in summary).
+ *
+ * Enabled may imply a partial rollout, which can be described using the 'rollout' field.
+ */
+ enabled: boolean;
+ /**
+ * @description The value served by this Feature Flag when it is disabled. This could be the actual value or an alias, as appropriate.
+ *
+ * This value may be presented to the user in the UI.
+ *
+ * @example Disabled
+ */
+ defaultValue?: string;
+ /**
+ * FeatureFlagRollout
+ * @description Information about the rollout of a Feature Flag in an environment (or in summary).
+ *
+ * Only one of 'percentage', 'text', or 'rules' should be provided. They will be used in that order if multiple are present.
+ *
+ * This information may be presented to the user in the UI.
+ *
+ * @example {
+ * "percentage": 80
+ * }
+ */
+ rollout?: {
+ /** @description If the Feature Flag rollout is a simple percentage rollout */
+ percentage?: number;
+ /** @description A text status to display that represents the rollout. This could be e.g. a named cohort. */
+ text?: string;
+ /** @description A count of the number of rules active for this Feature Flag in an environment. */
+ rules?: number;
+ };
+ };
+ /**
+ * Format: date-time
+ * @description The last-updated timestamp to present to the user as a summary of the state of the Feature Flag.
+ *
+ * Providers may choose to supply the last-updated timestamp from a specific environment, or the 'most recent' last-updated timestamp across all environments - whatever makes sense in the Provider system.
+ *
+ * Expected format is an RFC3339 formatted string.
+ *
+ * @example 2018-01-20T23:27:25.000Z
+ */
+ lastUpdated: string;
+ };
+ /**
+ * @description Detail information for this Feature Flag.
+ *
+ * This may be information for each environment the Feature Flag is defined in or a selection of environments made by the user, as appropriate.
+ */
+ details: {
+ /**
+ * Format: uri
+ * @description A URL users can use to link to this Feature Flag, in this environment.
+ *
+ * @example https://example.com/project/feature-123/production
+ */
+ url: string;
+ /**
+ * Format: date-time
+ * @description The last-updated timestamp for this Feature Flag, in this environment.
+ *
+ * Expected format is an RFC3339 formatted string.
+ *
+ * @example 2018-01-20T23:27:25.000Z
+ */
+ lastUpdated: string;
+ /**
+ * EnvironmentDetails
+ * @description Details of a single environment.
+ *
+ * At the simplest this must be the name of the environment.
+ *
+ * Ideally there is also type information which may be used to group data from multiple Feature Flags and other entities for visualisation in the UI.
+ *
+ * @example {
+ * "name": "prod-us-west",
+ * "type": "production"
+ * }
+ */
+ environment: {
+ /** @description The name of the environment. */
+ name: string;
+ /**
+ * @description The 'type' or 'category' of environment this environment belongs to.
+ * @enum {string}
+ */
+ type?: "development" | "testing" | "staging" | "production";
+ };
+ /**
+ * FeatureFlagStatus
+ * @description Status information about a single Feature Flag.
+ */
+ status: {
+ /**
+ * @description Whether the Feature Flag is enabled in the given environment (or in summary).
+ *
+ * Enabled may imply a partial rollout, which can be described using the 'rollout' field.
+ */
+ enabled: boolean;
+ /**
+ * @description The value served by this Feature Flag when it is disabled. This could be the actual value or an alias, as appropriate.
+ *
+ * This value may be presented to the user in the UI.
+ *
+ * @example Disabled
+ */
+ defaultValue?: string;
+ /**
+ * FeatureFlagRollout
+ * @description Information about the rollout of a Feature Flag in an environment (or in summary).
+ *
+ * Only one of 'percentage', 'text', or 'rules' should be provided. They will be used in that order if multiple are present.
+ *
+ * This information may be presented to the user in the UI.
+ *
+ * @example {
+ * "percentage": 80
+ * }
+ */
+ rollout?: {
+ /** @description If the Feature Flag rollout is a simple percentage rollout */
+ percentage?: number;
+ /** @description A text status to display that represents the rollout. This could be e.g. a named cohort. */
+ text?: string;
+ /** @description A count of the number of rules active for this Feature Flag in an environment. */
+ rules?: number;
+ };
+ };
+ }[];
+ };
+ };
+ };
+ /** @description Missing a JWT token, or token is invalid. */
+ 401: {
+ content: never;
+ };
+ /**
+ * @description The JWT token used does not correspond to an app that defines the Feature Flags module,
+ * or the app does not define the 'READ' scope.
+ */
+ 403: {
+ content: never;
+ };
+ /** @description No data found for the given Feature Flag ID. */
+ 404: {
+ content: never;
+ };
+ /** @description API rate limit has been exceeded. */
+ 429: {
+ content: never;
+ };
+ /** @description Service is unavailable due to maintenance or other reasons. */
+ 503: {
+ content: never;
+ };
+ /** @description An unknown error has occurred. */
+ default: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ };
+ /**
+ * Delete a Feature Flag by ID
+ * @description Delete the Feature Flag data currently stored for the given ID.
+ *
+ * Deletion is performed asynchronously. The getFeatureFlagById operation can be used to confirm that data has been deleted successfully (if needed).
+ *
+ * Only Connect apps that define the `jiraFeatureFlagInfoProvider` module can access this resource.
+ * This resource requires the 'DELETE' scope for Connect apps.
+ */
+ deleteFeatureFlagById: {
+ parameters: {
+ query?: {
+ /**
+ * @deprecated
+ * @description This parameter usage is no longer supported.
+ *
+ * An optional `_updateSequenceId` to use to control deletion.
+ *
+ * Only stored data with an `updateSequenceId` less than or equal to that provided will be deleted.
+ * This can be used help ensure submit/delete requests are applied correctly if issued close together.
+ */
+ _updateSequenceId?: number;
+ };
+ header: {
+ /**
+ * @description All requests must be signed with a Connect JWT token that corresponds to the Provider app installed in Jira.
+ *
+ * If the JWT token corresponds to an app that does not define Feature Flags module it will be rejected with a 403.
+ *
+ * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details.
+ */
+ Authorization: string;
+ };
+ path: {
+ /** @description The ID of the Feature Flag to delete. */
+ featureFlagId: string;
+ };
+ };
+ responses: {
+ /** @description Delete has been accepted. Data will eventually be removed from Jira if it exists. */
+ 202: {
+ content: never;
+ };
+ /** @description Missing a JWT token, or token is invalid. */
+ 401: {
+ content: never;
+ };
+ /**
+ * @description The JWT token used does not correspond to an app that defines the Feature Flags module,
+ * or the app does not define the 'DELETE' scope.
+ */
+ 403: {
+ content: never;
+ };
+ /** @description API rate limit has been exceeded. */
+ 429: {
+ content: never;
+ };
+ /** @description Service is unavailable due to maintenance or other reasons. */
+ 503: {
+ content: never;
+ };
+ /** @description An unknown error has occurred. */
+ default: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ };
+ /**
+ * Submit deployment data
+ * @description Update / insert deployment data.
+ *
+ * Deployments are identified by the combination of `pipelineId`, `environmentId` and `deploymentSequenceNumber`, and existing deployment data for the same deployment will be replaced if it exists and the `updateSequenceNumber` of existing data is less than the incoming data.
+ *
+ * Submissions are processed asynchronously. Submitted data will eventually be available in Jira. Most updates are available within a short period of time, but may take some time during peak load and/or maintenance times. The `getDeploymentByKey` operation can be used to confirm that data has been stored successfully (if needed).
+ *
+ * In the case of multiple deployments being submitted in one request, each is validated individually prior to submission. Details of which deployments failed submission (if any) are available in the response object.
+ *
+ * Only Connect apps that define the `jiraDeploymentInfoProvider` module, and on-premise integrations, can access this resource.
+ * This resource requires the 'WRITE' scope for Connect apps.
+ */
+ submitDeployments: {
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that corresponds to an app installed in Jira.
+ *
+ * If the Connect JWT token corresponds to an app that does not define `jiraDeploymentInfoProvider` module it will be rejected with a 403.
+ *
+ * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens.
+ * See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations.
+ */
+ Authorization: string;
+ };
+ };
+ /** @description Deployment data to submit. */
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * Properties
+ * @description Properties assigned to deployment data that can then be used for delete / query operations.
+ *
+ * Examples might be an account or user ID that can then be used to clean up data if an account is removed from the Provider system.
+ *
+ * Properties are supplied as key/value pairs, and a maximum of 5 properties can be supplied, keys cannot contain ':' or start with '_'.
+ *
+ * @example {
+ * "accountId": "account-234",
+ * "projectId": "project-123"
+ * }
+ */
+ properties?: {
+ [key: string]: string;
+ };
+ /**
+ * @description A list of deployments to submit to Jira.
+ *
+ * Each deployment may be associated with one or more Jira issue keys, and will be associated with any properties included in this request.
+ */
+ deployments: {
+ /**
+ * Format: int64
+ * @description This is the identifier for the deployment. It must be unique for the specified pipeline and environment. It must be a monotonically increasing number, as this is used to sequence the deployments.
+ *
+ * @example 100
+ */
+ deploymentSequenceNumber: number;
+ /**
+ * Format: int64
+ * @description A number used to apply an order to the updates to the deployment, as identified by the deploymentSequenceNumber, in the case of out-of-order receipt of update requests. It must be a monotonically increasing number. For example, epoch time could be one way to generate the updateSequenceNumber.
+ *
+ * @example 1
+ */
+ updateSequenceNumber: number;
+ /**
+ * @deprecated
+ * @description Deprecated. The Jira issue keys to associate the Deployment information with.
+ * Should replace this field with the "associations" field to associate Deployment information with issueKeys or other types of associations.
+ */
+ issueKeys?: string[];
+ /**
+ * @description The entities to associate the Deployment information with.
+ * It must contain at least one of IssueIdOrKeysAssociation or ServiceIdOrKeysAssociation.
+ */
+ associations?: OneOf<
+ [
+ {
+ /**
+ * @description Defines the asssociation type.
+ *
+ * @example issueIdOrKeys
+ * @enum {string}
+ */
+ associationType: "issueKeys" | "issueIdOrKeys";
+ /**
+ * @description The Jira issue keys to associate the Deployment information with.
+ *
+ * The number of values counted across all associationTypes (issueKeys,
+ * issueIdOrKeys and serviceIdOrKeys) must not exceed a limit of 500.
+ */
+ values: string[];
+ },
+ {
+ /**
+ * @description Defines the asssociation type.
+ *
+ * @example serviceIdOrKeys
+ * @enum {string}
+ */
+ associationType: "serviceIdOrKeys";
+ /**
+ * @description The service id or keys to associate the Deployment information with.
+ *
+ * The number of values counted across all associationTypes (issueKeys,
+ * issueIdOrKeys and serviceIdOrKeys) must not exceed a limit of 500.
+ */
+ values: string[];
+ },
+ ]
+ >[];
+ /**
+ * @description The human-readable name for the deployment. Will be shown in the UI.
+ *
+ * @example Deployment number 16 of Data Depot
+ */
+ displayName: string;
+ /**
+ * Format: uri
+ * @description A URL users can use to link to this deployment, in this environment.
+ *
+ * @example http://mydeployer.com/project1/1111-222-333/prod-east
+ */
+ url: string;
+ /**
+ * @description A short description of the deployment
+ *
+ * @example The bits are being transferred
+ */
+ description: string;
+ /**
+ * Format: date-time
+ * @description The last-updated timestamp to present to the user as a summary of the state of the deployment.
+ *
+ * @example 2018-01-20T23:27:25.000Z
+ */
+ lastUpdated: string;
+ /**
+ * @description An (optional) additional label that may be displayed with deployment information. Can be used to display version information etc. for the deployment.
+ *
+ * @example Release 2018-01-20_08-47-bc2421a
+ */
+ label?: string;
+ /**
+ * @description The state of the deployment
+ *
+ * @example in_progress
+ * @enum {string}
+ */
+ state: "unknown" | "pending" | "in_progress" | "cancelled" | "failed" | "rolled_back" | "successful";
+ /**
+ * Pipeline
+ * @description This object models the Continuous Delivery (CD) Pipeline concept, an automated process (usually comprised of multiple stages)
+ *
+ * for getting software from version control right through to the production environment.
+ */
+ pipeline: {
+ /**
+ * @description The identifier of this pipeline, must be unique for the provider.
+ *
+ * @example e9c906a7-451f-4fa6-ae1a-c389e2e2d87c
+ */
+ id: string;
+ /**
+ * @description The name of the pipeline to present to the user.
+ *
+ * @example Data Depot Deployment
+ */
+ displayName: string;
+ /**
+ * Format: uri
+ * @description A URL users can use to link to this deployment pipeline.
+ *
+ * @example http://mydeployer.com/project1
+ */
+ url: string;
+ };
+ /**
+ * Environment
+ * @description The environment that the deployment is present in.
+ */
+ environment: {
+ /**
+ * @description The identifier of this environment, must be unique for the provider so that it can be shared across pipelines.
+ *
+ * @example 8ec94d72-a4fc-4ac0-b31d-c5a595f373ba
+ */
+ id: string;
+ /**
+ * @description The name of the environment to present to the user.
+ *
+ * @example US East
+ */
+ displayName: string;
+ /**
+ * @description The type of the environment.
+ *
+ * @example production
+ * @enum {string}
+ */
+ type: "unmapped" | "development" | "testing" | "staging" | "production";
+ };
+ /**
+ * Commands
+ * @description A list of commands to be actioned for this Deployment
+ */
+ commands?: {
+ /**
+ * @description The command name.
+ *
+ * @example initiate_deployment_gating
+ */
+ command?: string;
+ }[];
+ /**
+ * @description The DeploymentData schema version used for this deployment data.
+ *
+ * Placeholder to support potential schema changes in the future.
+ *
+ * @default 1.0
+ * @example 1.0
+ * @enum {string}
+ */
+ schemaVersion?: "1.0";
+ /**
+ * triggeredBy
+ * @description Describes the user who triggered the deployment
+ */
+ triggeredBy?: {
+ /**
+ * @description The email address of the user. Used to associate the user with a Jira user. Max length is 255 characters.
+ * @example jane_doe@atlassian.com
+ */
+ email?: string;
+ };
+ }[];
+ /**
+ * ProviderMetadata
+ * @description Information about the provider. This is useful for auditing, logging, debugging,
+ * and other internal uses. It is not considered private information. Hence, it may not contain personally
+ * identifiable information.
+ */
+ providerMetadata?: {
+ /**
+ * @description An optional name of the source of the deployments data.
+ * @example Bamboo 6.10.2
+ */
+ product?: string;
+ };
+ };
+ };
+ };
+ responses: {
+ /**
+ * @description Submission accepted. Each submitted deployment that is of a valid format will eventually be available in Jira.
+ *
+ * Details of which deployments were submitted and which failed submission (due to data format problems etc.) are available in the response object.
+ */
+ 202: {
+ content: {
+ "application/json": {
+ /**
+ * @description The keys of deployments that have been accepted for submission. A deployment key is a composite key that consists of `pipelineId`, `environmentId` and `deploymentSequenceNumber`.
+ *
+ * A deployment may be rejected if it was only associated with unknown issue keys.
+ *
+ * Note that a deployment that isn't updated due to it's updateSequenceNumber being out of order is not considered a failed submission.
+ */
+ acceptedDeployments?: {
+ /**
+ * @description The identifier of a pipeline, must be unique for the provider.
+ *
+ * @example e9c906a7-451f-4fa6-ae1a-c389e2e2d87c
+ */
+ pipelineId: string;
+ /**
+ * @description The identifier of an environment, must be unique for the provider so that it can be shared across pipelines.
+ *
+ * @example 8ec94d72-a4fc-4ac0-b31d-c5a595f373ba
+ */
+ environmentId: string;
+ /**
+ * Format: int64
+ * @description This is the identifier for the deployment. It must be unique for the specified pipeline and environment. It must be a monotonically increasing number, as this is used to sequence the deployments.
+ *
+ * @example 100
+ */
+ deploymentSequenceNumber: number;
+ }[];
+ /**
+ * @description Details of deployments that have not been accepted for submission, usually due to a problem with the request data.
+ *
+ * The object will contain the deployment key and any errors associated with that deployment that have prevented it being submitted.
+ */
+ rejectedDeployments?: {
+ /**
+ * DeploymentKey
+ * @description Fields that uniquely reference a deployment.
+ */
+ key: {
+ /**
+ * @description The identifier of a pipeline, must be unique for the provider.
+ *
+ * @example e9c906a7-451f-4fa6-ae1a-c389e2e2d87c
+ */
+ pipelineId: string;
+ /**
+ * @description The identifier of an environment, must be unique for the provider so that it can be shared across pipelines.
+ *
+ * @example 8ec94d72-a4fc-4ac0-b31d-c5a595f373ba
+ */
+ environmentId: string;
+ /**
+ * Format: int64
+ * @description This is the identifier for the deployment. It must be unique for the specified pipeline and environment. It must be a monotonically increasing number, as this is used to sequence the deployments.
+ *
+ * @example 100
+ */
+ deploymentSequenceNumber: number;
+ };
+ /** @description The error messages for the rejected deployment */
+ errors: {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ }[];
+ /**
+ * @description Issue keys that are not known on this Jira instance (if any).
+ *
+ * These may be invalid keys (e.g. `UTF-8` is sometimes incorrectly identified as a Jira issue key), or they may be for projects that no longer exist.
+ *
+ * If a deployment has been associated with issue keys other than those in this array it will still be stored against those valid keys.
+ * If a deployment was only associated with issue keys deemed to be invalid it won't be persisted.
+ */
+ unknownIssueKeys?: string[];
+ /**
+ * @description Associations (e.g. Issue Keys or Service IDs) that are not known on this Jira instance (if any).
+ *
+ * These may be invalid keys (e.g. `UTF-8` is sometimes incorrectly identified as a Jira issue key), or they may be for projects that no longer exist.
+ *
+ * If a deployment has been associated with any other association other than those in this array it will still be stored against those valid associations.
+ * If a deployment was only associated with the associations in this array, it is deemed to be invalid and it won't be persisted.
+ */
+ unknownAssociations?: (
+ | {
+ /**
+ * @description Defines the asssociation type.
+ *
+ * @example issueIdOrKeys
+ * @enum {string}
+ */
+ associationType: "issueKeys" | "issueIdOrKeys";
+ /**
+ * @description The Jira issue keys to associate the Deployment information with.
+ *
+ * The number of values counted across all associationTypes (issueKeys,
+ * issueIdOrKeys and serviceIdOrKeys) must not exceed a limit of 500.
+ */
+ values: string[];
+ }
+ | {
+ /**
+ * @description Defines the asssociation type.
+ *
+ * @example serviceIdOrKeys
+ * @enum {string}
+ */
+ associationType: "serviceIdOrKeys";
+ /**
+ * @description The service id or keys to associate the Deployment information with.
+ *
+ * The number of values counted across all associationTypes (issueKeys,
+ * issueIdOrKeys and serviceIdOrKeys) must not exceed a limit of 500.
+ */
+ values: string[];
+ }
+ | {
+ /**
+ * @description Defines the association type. Currently supported entities can be found in this field's value enums list.
+ *
+ * @enum {string}
+ */
+ associationType: "commit";
+ /**
+ * @description The entity keys that represent the entities to be associated.
+ * The number of values counted across all associationTypes (issueKeys, issueIdOrKeys, serviceIdOrKeys, supported ATIs and entity associations) must not exceed a limit of 500.
+ */
+ values: {
+ /**
+ * @description The hash for the Commit.
+ *
+ * @example b00152456cf4
+ */
+ commitHash: string;
+ /**
+ * @description The ID of the Repository that the Commit belongs to.
+ *
+ * @example de7fbebffabe
+ */
+ repositoryId: string;
+ }[];
+ }
+ )[];
+ };
+ };
+ };
+ /**
+ * @description Request has incorrect format.
+ *
+ * Note that in the case of an individual deployment having an invalid format (rather than the request as a whole) the response for the request will be a 202 and details of the invalid deployment will be contained in the response object.
+ */
+ 400: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ /** @description Missing a JWT token, or token is invalid. */
+ 401: {
+ content: never;
+ };
+ /**
+ * @description The JWT token used does not correspond to an app that defines the `jiraDeploymentInfoProvider` module,
+ * or the app does not define the 'WRITE' scope.
+ */
+ 403: {
+ content: never;
+ };
+ /** @description Data is too large. Submit fewer deployments in each payload. */
+ 413: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ /** @description API rate limit has been exceeded. */
+ 429: {
+ content: never;
+ };
+ /** @description Service is unavailable due to maintenance or other reasons. */
+ 503: {
+ content: never;
+ };
+ /** @description An unknown error has occurred. */
+ default: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ };
+ /**
+ * Delete deployments by Property
+ * @description Bulk delete all deployments that match the given request.
+ *
+ * One or more query params must be supplied to specify the Properties to delete by. Optional param `_updateSequenceNumber` is no longer supported.
+ * If more than one Property is provided, data will be deleted that matches ALL of the Properties (i.e. treated as AND).
+ * See the documentation for the `submitDeployments` operation for more details.
+ *
+ * Example operation: DELETE /bulkByProperties?accountId=account-123&createdBy=user-456
+ *
+ * Deletion is performed asynchronously. The `getDeploymentByKey` operation can be used to confirm that data has been deleted successfully (if needed).
+ *
+ * Only Connect apps that define the `jiraDeploymentInfoProvider` module, and on-premise integrations, can access this resource.
+ * This resource requires the 'DELETE' scope for Connect apps.
+ */
+ deleteDeploymentsByProperty: {
+ parameters: {
+ query?: {
+ /**
+ * @deprecated
+ * @description This parameter usage is no longer supported.
+ *
+ * An optional `updateSequenceNumber` to use to control deletion.
+ *
+ * Only stored data with an `updateSequenceNumber` less than or equal to that provided will be deleted.
+ * This can be used help ensure submit/delete requests are applied correctly if issued close together.
+ *
+ * If not provided, all stored data that matches the request will be deleted.
+ */
+ _updateSequenceNumber?: number;
+ };
+ header: {
+ /**
+ * @description All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that corresponds to an app installed in Jira.
+ *
+ * If the Connect JWT token corresponds to an app that does not define `jiraDeploymentInfoProvider` module it will be rejected with a 403.
+ *
+ * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens.
+ * See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations.
+ */
+ Authorization: string;
+ };
+ };
+ responses: {
+ /** @description Delete accepted. Data will eventually be removed from Jira. */
+ 202: {
+ content: never;
+ };
+ /** @description Request has incorrect format (e.g. missing at least one Property param). */
+ 400: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ /** @description Missing a JWT token, or token is invalid. */
+ 401: {
+ content: never;
+ };
+ /**
+ * @description The JWT token used does not correspond to an app that defines the `jiraDeploymentInfoProvider` module,
+ * or the app does not define the 'DELETE' scope for Connect apps.
+ */
+ 403: {
+ content: never;
+ };
+ /** @description API rate limit has been exceeded. */
+ 429: {
+ content: never;
+ };
+ /** @description Service is unavailable due to maintenance or other reasons. */
+ 503: {
+ content: never;
+ };
+ /** @description An unknown error has occurred. */
+ default: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ };
+ /**
+ * Get a deployment by key
+ * @description Retrieve the currently stored deployment data for the given `pipelineId`, `environmentId` and `deploymentSequenceNumber` combination.
+ *
+ * The result will be what is currently stored, ignoring any pending updates or deletes.
+ *
+ * Only Connect apps that define the `jiraDeploymentInfoProvider` module, and on-premise integrations, can access this resource.
+ * This resource requires the 'READ' scope for Connect apps.
+ */
+ getDeploymentByKey: {
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that corresponds to an app installed in Jira.
+ *
+ * If the Connect JWT token corresponds to an app that does not define `jiraDeploymentInfoProvider` module it will be rejected with a 403.
+ *
+ * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens.
+ * See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations.
+ */
+ Authorization: string;
+ };
+ path: {
+ /** @description The ID of the deployment's pipeline. */
+ pipelineId: string;
+ /** @description The ID of the deployment's environment. */
+ environmentId: string;
+ /** @description The deployment's deploymentSequenceNumber. */
+ deploymentSequenceNumber: number;
+ };
+ };
+ responses: {
+ /** @description The deployment data currently stored for the given ID. */
+ 200: {
+ content: {
+ "application/json": {
+ /**
+ * Format: int64
+ * @description This is the identifier for the deployment. It must be unique for the specified pipeline and environment. It must be a monotonically increasing number, as this is used to sequence the deployments.
+ *
+ * @example 100
+ */
+ deploymentSequenceNumber: number;
+ /**
+ * Format: int64
+ * @description A number used to apply an order to the updates to the deployment, as identified by the deploymentSequenceNumber, in the case of out-of-order receipt of update requests. It must be a monotonically increasing number. For example, epoch time could be one way to generate the updateSequenceNumber.
+ *
+ * @example 1
+ */
+ updateSequenceNumber: number;
+ /**
+ * @deprecated
+ * @description Deprecated. The Jira issue keys to associate the Deployment information with.
+ * Should replace this field with the "associations" field to associate Deployment information with issueKeys or other types of associations.
+ */
+ issueKeys?: string[];
+ /**
+ * @description The entities to associate the Deployment information with.
+ * It must contain at least one of IssueIdOrKeysAssociation or ServiceIdOrKeysAssociation.
+ */
+ associations?: OneOf<
+ [
+ {
+ /**
+ * @description Defines the asssociation type.
+ *
+ * @example issueIdOrKeys
+ * @enum {string}
+ */
+ associationType: "issueKeys" | "issueIdOrKeys";
+ /**
+ * @description The Jira issue keys to associate the Deployment information with.
+ *
+ * The number of values counted across all associationTypes (issueKeys,
+ * issueIdOrKeys and serviceIdOrKeys) must not exceed a limit of 500.
+ */
+ values: string[];
+ },
+ {
+ /**
+ * @description Defines the asssociation type.
+ *
+ * @example serviceIdOrKeys
+ * @enum {string}
+ */
+ associationType: "serviceIdOrKeys";
+ /**
+ * @description The service id or keys to associate the Deployment information with.
+ *
+ * The number of values counted across all associationTypes (issueKeys,
+ * issueIdOrKeys and serviceIdOrKeys) must not exceed a limit of 500.
+ */
+ values: string[];
+ },
+ ]
+ >[];
+ /**
+ * @description The human-readable name for the deployment. Will be shown in the UI.
+ *
+ * @example Deployment number 16 of Data Depot
+ */
+ displayName: string;
+ /**
+ * Format: uri
+ * @description A URL users can use to link to this deployment, in this environment.
+ *
+ * @example http://mydeployer.com/project1/1111-222-333/prod-east
+ */
+ url: string;
+ /**
+ * @description A short description of the deployment
+ *
+ * @example The bits are being transferred
+ */
+ description: string;
+ /**
+ * Format: date-time
+ * @description The last-updated timestamp to present to the user as a summary of the state of the deployment.
+ *
+ * @example 2018-01-20T23:27:25.000Z
+ */
+ lastUpdated: string;
+ /**
+ * @description An (optional) additional label that may be displayed with deployment information. Can be used to display version information etc. for the deployment.
+ *
+ * @example Release 2018-01-20_08-47-bc2421a
+ */
+ label?: string;
+ /**
+ * @description The state of the deployment
+ *
+ * @example in_progress
+ * @enum {string}
+ */
+ state: "unknown" | "pending" | "in_progress" | "cancelled" | "failed" | "rolled_back" | "successful";
+ /**
+ * Pipeline
+ * @description This object models the Continuous Delivery (CD) Pipeline concept, an automated process (usually comprised of multiple stages)
+ *
+ * for getting software from version control right through to the production environment.
+ */
+ pipeline: {
+ /**
+ * @description The identifier of this pipeline, must be unique for the provider.
+ *
+ * @example e9c906a7-451f-4fa6-ae1a-c389e2e2d87c
+ */
+ id: string;
+ /**
+ * @description The name of the pipeline to present to the user.
+ *
+ * @example Data Depot Deployment
+ */
+ displayName: string;
+ /**
+ * Format: uri
+ * @description A URL users can use to link to this deployment pipeline.
+ *
+ * @example http://mydeployer.com/project1
+ */
+ url: string;
+ };
+ /**
+ * Environment
+ * @description The environment that the deployment is present in.
+ */
+ environment: {
+ /**
+ * @description The identifier of this environment, must be unique for the provider so that it can be shared across pipelines.
+ *
+ * @example 8ec94d72-a4fc-4ac0-b31d-c5a595f373ba
+ */
+ id: string;
+ /**
+ * @description The name of the environment to present to the user.
+ *
+ * @example US East
+ */
+ displayName: string;
+ /**
+ * @description The type of the environment.
+ *
+ * @example production
+ * @enum {string}
+ */
+ type: "unmapped" | "development" | "testing" | "staging" | "production";
+ };
+ /**
+ * Commands
+ * @description A list of commands to be actioned for this Deployment
+ */
+ commands?: {
+ /**
+ * @description The command name.
+ *
+ * @example initiate_deployment_gating
+ */
+ command?: string;
+ }[];
+ /**
+ * @description The DeploymentData schema version used for this deployment data.
+ *
+ * Placeholder to support potential schema changes in the future.
+ *
+ * @default 1.0
+ * @example 1.0
+ * @enum {string}
+ */
+ schemaVersion?: "1.0";
+ };
+ };
+ };
+ /** @description Missing a JWT token, or token is invalid. */
+ 401: {
+ content: never;
+ };
+ /**
+ * @description The JWT token used does not correspond to an app that defines the `jiraDeploymentInfoProvider` module,
+ *
+ * or the app does not define the 'READ' scope.
+ */
+ 403: {
+ content: never;
+ };
+ /** @description No data found for the given deployment ID. */
+ 404: {
+ content: never;
+ };
+ /** @description API rate limit has been exceeded. */
+ 429: {
+ content: never;
+ };
+ /** @description Service is unavailable due to maintenance or other reasons. */
+ 503: {
+ content: never;
+ };
+ /** @description An unknown error has occurred. */
+ default: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ };
+ /**
+ * Delete a deployment by key
+ * @description Delete the currently stored deployment data for the given `pipelineId`, `environmentId` and `deploymentSequenceNumber` combination.
+ *
+ * Deletion is performed asynchronously. The `getDeploymentByKey` operation can be used to confirm that data has been deleted successfully (if needed).
+ *
+ * Only Connect apps that define the `jiraDeploymentInfoProvider` module, and on-premise integrations, can access this resource.
+ * This resource requires the 'DELETE' scope for Connect apps.
+ */
+ deleteDeploymentByKey: {
+ parameters: {
+ query?: {
+ /**
+ * @deprecated
+ * @description This parameter usage is no longer supported.
+ *
+ * An optional `_updateSequenceNumber` to use to control deletion.
+ *
+ * Only stored data with an `updateSequenceNumber` less than or equal to that provided will be deleted.
+ * This can be used help ensure submit/delete requests are applied correctly if issued close together.
+ */
+ _updateSequenceNumber?: number;
+ };
+ header: {
+ /**
+ * @description All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that corresponds to an app installed in Jira.
+ *
+ * If the Connect JWT token corresponds to an app that does not define `jiraDeploymentInfoProvider` module it will be rejected with a 403.
+ *
+ * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens.
+ * See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations.
+ */
+ Authorization: string;
+ };
+ path: {
+ /** @description The ID of the deployment's pipeline. */
+ pipelineId: string;
+ /** @description The ID of the deployment's environment. */
+ environmentId: string;
+ /** @description The deployment's deploymentSequenceNumber. */
+ deploymentSequenceNumber: number;
+ };
+ };
+ responses: {
+ /** @description Delete has been accepted. Data will eventually be removed from Jira if it exists. */
+ 202: {
+ content: never;
+ };
+ /** @description Missing a JWT token, or token is invalid. */
+ 401: {
+ content: never;
+ };
+ /**
+ * @description The JWT token used does not correspond to an app that defines the `jiraDeploymentInfoProvider` module,
+ * or the app does not define the 'DELETE' scope.
+ */
+ 403: {
+ content: never;
+ };
+ /** @description API rate limit has been exceeded. */
+ 429: {
+ content: never;
+ };
+ /** @description Service is unavailable due to maintenance or other reasons. */
+ 503: {
+ content: never;
+ };
+ /** @description An unknown error has occurred. */
+ default: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ };
+ /**
+ * Get deployment gating status by key
+ * @description Retrieve the Deployment gating status for the given `pipelineId + environmentId + deploymentSequenceNumber` combination.
+ * Only apps that define the `jiraDeploymentInfoProvider` module can access this resource. This resource requires the 'READ' scope.
+ */
+ getDeploymentGatingStatusByKey: {
+ parameters: {
+ path: {
+ /** @description The ID of the Deployment's pipeline. */
+ pipelineId: string;
+ /** @description The ID of the Deployment's environment. */
+ environmentId: string;
+ /** @description The Deployment's deploymentSequenceNumber. */
+ deploymentSequenceNumber: number;
+ };
+ };
+ responses: {
+ /** @description The current gating status for the given Deployment */
+ 200: {
+ content: {
+ "application/json": {
+ /**
+ * Format: int64
+ * @description This is the identifier for the Deployment.
+ *
+ * @example 100
+ */
+ deploymentSequenceNumber?: number;
+ /**
+ * @description The ID of the Deployment's pipeline.
+ *
+ * @example e9c906a7-451f-4fa6-ae1a-c389e2e2d87c
+ */
+ pipelineId?: string;
+ /**
+ * @description The ID of the Deployment's environment.
+ *
+ * @example 8ec94d72-a4fc-4ac0-b31d-c5a595f373ba
+ */
+ environmentId?: string;
+ /**
+ * Format: date-time
+ * @description Time the deployment gating status was updated.
+ *
+ * @example 2020-08-25T06:04:50.239Z
+ */
+ updatedTimestamp?: string;
+ /**
+ * @description The gating status
+ *
+ * @example allowed
+ * @enum {string}
+ */
+ gatingStatus?: "allowed" | "prevented" | "awaiting" | "invalid";
+ details?: {
+ /**
+ * @description The type of the gating status details.
+ *
+ * @example issue
+ * @enum {string}
+ */
+ type: "issue";
+ /**
+ * IssueKey
+ * @description An issue key that references an issue in Jira.
+ *
+ * @example ABC-123
+ */
+ issueKey: string;
+ /**
+ * Format: uri
+ * @description A full HTTPS link to the Jira issue for the change request gating this Deployment. This field is provided if the details type is issue.
+ *
+ * @example https://your-domain.atlassian.net/servicedesk/customer/portal/1/ZAINA-123
+ */
+ issueLink: string;
+ }[];
+ };
+ };
+ };
+ /** @description Missing a JWT token, or token is invalid. */
+ 401: {
+ content: never;
+ };
+ /** @description The JWT token used does not correspond to an app that defines the `jiraDeploymentInfoProvider` module, */
+ 403: {
+ content: never;
+ };
+ /** @description No data found for the given deployment ID. */
+ 404: {
+ content: never;
+ };
+ /** @description API rate limit has been exceeded. */
+ 429: {
+ content: never;
+ };
+ /** @description Service is unavailable due to maintenance or other reasons. */
+ 503: {
+ content: never;
+ };
+ /** @description An unknown error has occurred. */
+ default: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ };
+ /**
+ * Submit build data
+ * @description Update / insert builds data.
+ *
+ * Builds are identified by the combination of `pipelineId` and `buildNumber`, and existing build data for the same
+ * build will be replaced if it exists and the `updateSequenceNumber` of the existing data is less than the
+ * incoming data.
+ *
+ * Submissions are performed asynchronously. Submitted data will eventually be available in Jira; most updates are
+ * available within a short period of time, but may take some time during peak load and/or maintenance times.
+ * The `getBuildByKey` operation can be used to confirm that data has been stored successfully (if needed).
+ *
+ * In the case of multiple builds being submitted in one request, each is validated individually prior to
+ * submission. Details of which build failed submission (if any) are available in the response object.
+ *
+ * Only Connect apps that define the `jiraBuildInfoProvider` module, and on-premise integrations, can access this resource.
+ * This resource requires the 'WRITE' scope for Connect apps.
+ */
+ submitBuilds: {
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that corresponds to an app installed in Jira.
+ *
+ * If the Connect JWT token corresponds to an app that does not define `jiraBuildInfoProvider` module it will be rejected with a 403.
+ *
+ * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens.
+ * See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations.
+ */
+ Authorization: string;
+ };
+ };
+ /** @description Builds data to submit. */
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * Properties
+ * @description Properties assigned to build data that can then be used for delete / query operations.
+ *
+ * Examples might be an account or user ID that can then be used to clean up data if an account is removed from
+ * the Provider system.
+ *
+ * Note that these properties will never be returned with build data. They are not intended for use as
+ * metadata to associate with a build. Internally they are stored as a hash so that personal information etc.
+ * is never stored within Jira.
+ *
+ * Properties are supplied as key/value pairs, a maximum of 5 properties can be supplied, and keys must not
+ * contain ':' or start with '_'.
+ *
+ * @example {
+ * "accountId": "account-234",
+ * "projectId": "project-123"
+ * }
+ */
+ properties?: {
+ [key: string]: string;
+ };
+ /**
+ * @description A list of builds to submit to Jira.
+ *
+ * Each build may be associated with one or more Jira issue keys, and will be associated with any properties
+ * included in this request.
+ */
+ builds: {
+ /**
+ * @description The schema version used for this data.
+ *
+ * Placeholder to support potential schema changes in the future.
+ *
+ * @default 1.0
+ * @example 1.0
+ * @enum {string}
+ */
+ schemaVersion?: "1.0";
+ /**
+ * @description An ID that relates a sequence of builds. Depending on your use case this might be a project ID, pipeline ID,
+ * plan key etc. - whatever logical unit you use to group a sequence of builds.
+ *
+ * The combination of `pipelineId` and `buildNumber` must uniquely identify a build you have provided.
+ *
+ * @example my-build-plan
+ */
+ pipelineId: string;
+ /**
+ * Format: int64
+ * @description Identifies a build within the sequence of builds identified by the build `pipelineId`.
+ *
+ * Used to identify the 'most recent' build in that sequence of builds.
+ *
+ * The combination of `pipelineId` and `buildNumber` must uniquely identify a build you have provided.
+ *
+ * @example 16
+ */
+ buildNumber: number;
+ /**
+ * Format: int64
+ * @description A number used to apply an order to the updates to the build, as identified by `pipelineId` and `buildNumber`,
+ * in the case of out-of-order receipt of update requests.
+ *
+ * It must be a monotonically increasing number. For example, epoch time could be one way to generate the
+ * `updateSequenceNumber`.
+ *
+ * Updates for a build that is received with an `updateSqeuenceNumber` less than or equal to what is currently
+ * stored will be ignored.
+ *
+ * @example 1523494301448
+ */
+ updateSequenceNumber: number;
+ /**
+ * @description The human-readable name for the build.
+ *
+ * Will be shown in the UI.
+ *
+ * @example My Project build #16
+ */
+ displayName: string;
+ /**
+ * @description An optional description to attach to this build.
+ *
+ * This may be anything that makes sense in your system.
+ *
+ * @example My Project build #16: Failed
+ */
+ description?: string;
+ /** @description A human-readable string that to provide information about the build. */
+ label?: string;
+ /**
+ * Format: URL
+ * @description The URL to this build in your system.
+ */
+ url: string;
+ /**
+ * BuildState
+ * @description The state of a build.
+ *
+ * * `pending` - The build is queued, or some manual action is required.
+ * * `in_progress` - The build is currently running.
+ * * `successful` - The build completed successfully.
+ * * `failed` - The build failed.
+ * * `cancelled` - The build has been cancelled or stopped.
+ * * `unknown` - The build is in an unknown state.
+ *
+ * @example failed
+ * @enum {string}
+ */
+ state: "pending" | "in_progress" | "successful" | "failed" | "cancelled" | "unknown";
+ /**
+ * Format: date-time
+ * @description The last-updated timestamp to present to the user as a summary of the state of the build.
+ *
+ * @example 2018-01-20T23:27:25.000Z
+ */
+ lastUpdated: string;
+ /**
+ * @description The Jira issue keys to associate the build information with.
+ *
+ * You are free to associate issue keys in any way you like. However, we recommend that you use the name
+ * of the branch the build was executed on, and extract issue keys from that name using a simple regex. This has
+ * the advantage that it provides an intuitive association of builds to issue keys.
+ */
+ issueKeys: string[];
+ /**
+ * TestInfo
+ * @description Information about tests that were executed during a build.
+ */
+ testInfo?: {
+ /**
+ * Format: int64
+ * @description The total number of tests considered during a build.
+ *
+ * @example 150
+ */
+ totalNumber: number;
+ /**
+ * Format: int64
+ * @description The number of tests that passed during a build.
+ *
+ * @example 145
+ */
+ numberPassed: number;
+ /**
+ * Format: int64
+ * @description The number of tests that failed during a build.
+ *
+ * @example 5
+ */
+ numberFailed: number;
+ /**
+ * Format: int64
+ * @description The number of tests that were skipped during a build.
+ *
+ * @default 0
+ * @example 0
+ */
+ numberSkipped?: number;
+ };
+ /** @description Optional information that links a build to a commit, branch etc. */
+ references?: {
+ /**
+ * BuildCommitReference
+ * @description Details about the commit the build was run against.
+ */
+ commit?: {
+ /**
+ * @description The ID of the commit. E.g. for a Git repository this would be the SHA1 hash.
+ *
+ * @example 08cd9c26b2b8d7cf6e6af6b49da8895d065c259f
+ */
+ id: string;
+ /**
+ * @description An identifier for the repository containing the commit.
+ *
+ * In most cases this should be the URL of the repository in the SCM provider.
+ *
+ * For cases where the build was executed against a local repository etc. this should be some identifier that is
+ * unique to that repository.
+ *
+ * @example https://bitbucket.org/atlassian/biij-vendor-api
+ */
+ repositoryUri: string;
+ };
+ /**
+ * BuildRefReference
+ * @description Details about the ref the build was run on.
+ */
+ ref?: {
+ /**
+ * @description The name of the ref the build ran on
+ *
+ * @example feature/ISSUE-123-some-work
+ */
+ name: string;
+ /**
+ * @description An identifer for the ref.
+ *
+ * In most cases this should be the URL of the tag/branch etc. in the SCM provider.
+ *
+ * For cases where the build was executed against a local repository etc. this should be something that uniquely
+ * identifies the ref.
+ *
+ * @example https://bitbucket.org/atlassian/biij-vendor-api/refs/feature/ISSUE-123-some-work
+ */
+ uri: string;
+ };
+ }[];
+ }[];
+ /**
+ * ProviderMetadata
+ * @description Information about the provider. This is useful for auditing, logging, debugging,
+ * and other internal uses. It is not considered private information. Hence, it may not contain personally
+ * identifiable information.
+ */
+ providerMetadata?: {
+ /**
+ * @description An optional name of the source of the builds data.
+ * @example Bamboo 6.10.2
+ */
+ product?: string;
+ };
+ };
+ };
+ };
+ responses: {
+ /**
+ * @description Submission accepted. Each submitted build that is of a valid format will be eventually available in Jira.
+ *
+ * Details of which builds were submitted and which failed submission (due to data format problems etc.)
+ * are available in the response object.
+ */
+ 202: {
+ content: {
+ "application/json": {
+ /**
+ * @description The keys of builds that have been accepted for submission. A build key is a composite key that consists of
+ * `pipelineId` and `buildNumber`.
+ *
+ * A build may be rejected if it was only associated with unknown issue keys, or if the submitted data for that
+ * build does not match the required schema.
+ *
+ * Note that a build that isn't updated due to it's `updateSequenceNumber` being out of order is not
+ * considered a failed submission.
+ */
+ acceptedBuilds?: {
+ /**
+ * @description An ID that relates a sequence of builds. Depending on your system this might be a project ID, pipeline ID,
+ * plan key etc. - whatever logical unit you use to group a sequence of builds.
+ *
+ * The combination of `pipelineId` and `buildNumber` must uniquely identify the build.
+ *
+ * @example my-build-plan
+ */
+ pipelineId: string;
+ /**
+ * Format: int64
+ * @description Identifies a build within the sequence of builds identified by the build `pipelineId`.
+ *
+ * Used to identify the 'most recent' build in that sequence of builds.
+ *
+ * The combination of `pipelineId` and `buildNumber` must uniquely identify the build.
+ *
+ * @example 16
+ */
+ buildNumber: number;
+ }[];
+ /**
+ * @description Details of builds that have not been accepted for submission.
+ *
+ * A build may be rejected if it was only associated with unknown issue keys, or if the submitted data for the
+ * build does not match the required schema.
+ */
+ rejectedBuilds?: {
+ /**
+ * BuildKey
+ * @description Fields that uniquely reference a build.
+ */
+ key: {
+ /**
+ * @description An ID that relates a sequence of builds. Depending on your system this might be a project ID, pipeline ID,
+ * plan key etc. - whatever logical unit you use to group a sequence of builds.
+ *
+ * The combination of `pipelineId` and `buildNumber` must uniquely identify the build.
+ *
+ * @example my-build-plan
+ */
+ pipelineId: string;
+ /**
+ * Format: int64
+ * @description Identifies a build within the sequence of builds identified by the build `pipelineId`.
+ *
+ * Used to identify the 'most recent' build in that sequence of builds.
+ *
+ * The combination of `pipelineId` and `buildNumber` must uniquely identify the build.
+ *
+ * @example 16
+ */
+ buildNumber: number;
+ };
+ /** @description The error messages for the rejected build */
+ errors: {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ }[];
+ /**
+ * @description Issue keys that are not known on this Jira instance (if any).
+ *
+ * These may be invalid keys (e.g. `UTF-8` is sometimes incorrectly identified as a Jira issue key), or they
+ * may be for projects that no longer exist.
+ *
+ * If a build has been associated with issue keys other than those in this array it will still be stored against
+ * those valid keys. If a build was only associated with issue keys deemed to be invalid it won't be persisted.
+ */
+ unknownIssueKeys?: string[];
+ };
+ };
+ };
+ /**
+ * @description Request has incorrect format.
+ *
+ * Note that in the case of an individual build having an invalid format (rather than the request as a whole)
+ * the response for the request will be a 202 and details of the invalid build will be contained in the
+ * response object.
+ */
+ 400: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ /** @description Missing a JWT token, or token is invalid. */
+ 401: {
+ content: never;
+ };
+ /**
+ * @description The JWT token used does not correspond to an app that defines the `jiraBuildInfoProvider` module,
+ * or the app does not define the 'WRITE' scope.
+ */
+ 403: {
+ content: never;
+ };
+ /** @description Data is too large. Submit fewer builds in each payload. */
+ 413: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ /** @description API rate limit has been exceeded. */
+ 429: {
+ content: never;
+ };
+ /** @description Service is unavailable due to maintenance or other reasons. */
+ 503: {
+ content: never;
+ };
+ /** @description An unknown error has occurred. */
+ default: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ };
+ /**
+ * Delete builds by Property
+ * @description Bulk delete all builds data that match the given request.
+ *
+ * One or more query params must be supplied to specify Properties to delete by.
+ * Optional param `_updateSequenceNumber` is no longer supported.
+ * If more than one Property is provided, data will be deleted that matches ALL of the
+ * Properties (e.g. treated as an AND).
+ *
+ * See the documentation for the `submitBuilds` operation for more details.
+ *
+ * e.g. DELETE /bulkByProperties?accountId=account-123&repoId=repo-345
+ *
+ * Deletion is performed asynchronously. The `getBuildByKey` operation can be used to confirm that data has been
+ * deleted successfully (if needed).
+ *
+ * Only Connect apps that define the `jiraBuildInfoProvider` module, and on-premise integrations, can access this resource.
+ * This resource requires the 'DELETE' scope for Connect apps.
+ */
+ deleteBuildsByProperty: {
+ parameters: {
+ query?: {
+ /**
+ * @deprecated
+ * @description This parameter usage is no longer supported.
+ *
+ * An optional `_updateSequenceNumber` to use to control deletion.
+ *
+ * Only stored data with an `updateSequenceNumber` less than or equal to that provided will be deleted.
+ * This can be used help ensure submit/delete requests are applied correctly if issued close together.
+ *
+ * If not provided, all stored data that matches the request will be deleted.
+ */
+ _updateSequenceNumber?: number;
+ };
+ header: {
+ /**
+ * @description All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that corresponds to an app installed in Jira.
+ *
+ * If the Connect JWT token corresponds to an app that does not define `jiraBuildInfoProvider` module it will be rejected with a 403.
+ *
+ * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens.
+ * See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations.
+ */
+ Authorization: string;
+ };
+ };
+ responses: {
+ /** @description Delete accepted. Data will eventually be removed from Jira. */
+ 202: {
+ content: never;
+ };
+ /** @description Request has incorrect format (e.g. missing at least one Property param). */
+ 400: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ /** @description Missing a JWT token, or token is invalid. */
+ 401: {
+ content: never;
+ };
+ /**
+ * @description The JWT token used does not correspond to an app that defines the `jiraBuildInfoProvider` module,
+ * or the app does not define the 'DELETE' scope.
+ */
+ 403: {
+ content: never;
+ };
+ /** @description API rate limit has been exceeded. */
+ 429: {
+ content: never;
+ };
+ /** @description Service is unavailable due to maintenance or other reasons. */
+ 503: {
+ content: never;
+ };
+ /** @description An unknown error has occurred. */
+ default: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ };
+ /**
+ * Get a build by key
+ * @description Retrieve the currently stored build data for the given `pipelineId` and `buildNumber` combination.
+ *
+ * The result will be what is currently stored, ignoring any pending updates or deletes.
+ *
+ * Only Connect apps that define the `jiraBuildInfoProvider` module, and on-premise integrations, can access this resource.
+ * This resource requires the 'READ' scope for Connect apps.
+ */
+ getBuildByKey: {
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that corresponds to an app installed in Jira.
+ *
+ * If the Connect JWT token corresponds to an app that does not define `jiraBuildInfoProvider` module it will be rejected with a 403.
+ *
+ * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens.
+ * See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations.
+ */
+ Authorization: string;
+ };
+ path: {
+ /** @description The `pipelineId` of the build. */
+ pipelineId: string;
+ /** @description The `buildNumber` of the build. */
+ buildNumber: number;
+ };
+ };
+ responses: {
+ /** @description The build data currently stored for the given key. */
+ 200: {
+ content: {
+ "application/json": {
+ /**
+ * @description The schema version used for this data.
+ *
+ * Placeholder to support potential schema changes in the future.
+ *
+ * @default 1.0
+ * @example 1.0
+ * @enum {string}
+ */
+ schemaVersion?: "1.0";
+ /**
+ * @description An ID that relates a sequence of builds. Depending on your use case this might be a project ID, pipeline ID,
+ * plan key etc. - whatever logical unit you use to group a sequence of builds.
+ *
+ * The combination of `pipelineId` and `buildNumber` must uniquely identify a build you have provided.
+ *
+ * @example my-build-plan
+ */
+ pipelineId: string;
+ /**
+ * Format: int64
+ * @description Identifies a build within the sequence of builds identified by the build `pipelineId`.
+ *
+ * Used to identify the 'most recent' build in that sequence of builds.
+ *
+ * The combination of `pipelineId` and `buildNumber` must uniquely identify a build you have provided.
+ *
+ * @example 16
+ */
+ buildNumber: number;
+ /**
+ * Format: int64
+ * @description A number used to apply an order to the updates to the build, as identified by `pipelineId` and `buildNumber`,
+ * in the case of out-of-order receipt of update requests.
+ *
+ * It must be a monotonically increasing number. For example, epoch time could be one way to generate the
+ * `updateSequenceNumber`.
+ *
+ * Updates for a build that is received with an `updateSqeuenceNumber` less than or equal to what is currently
+ * stored will be ignored.
+ *
+ * @example 1523494301448
+ */
+ updateSequenceNumber: number;
+ /**
+ * @description The human-readable name for the build.
+ *
+ * Will be shown in the UI.
+ *
+ * @example My Project build #16
+ */
+ displayName: string;
+ /**
+ * @description An optional description to attach to this build.
+ *
+ * This may be anything that makes sense in your system.
+ *
+ * @example My Project build #16: Failed
+ */
+ description?: string;
+ /** @description A human-readable string that to provide information about the build. */
+ label?: string;
+ /**
+ * Format: URL
+ * @description The URL to this build in your system.
+ */
+ url: string;
+ /**
+ * BuildState
+ * @description The state of a build.
+ *
+ * * `pending` - The build is queued, or some manual action is required.
+ * * `in_progress` - The build is currently running.
+ * * `successful` - The build completed successfully.
+ * * `failed` - The build failed.
+ * * `cancelled` - The build has been cancelled or stopped.
+ * * `unknown` - The build is in an unknown state.
+ *
+ * @example failed
+ * @enum {string}
+ */
+ state: "pending" | "in_progress" | "successful" | "failed" | "cancelled" | "unknown";
+ /**
+ * Format: date-time
+ * @description The last-updated timestamp to present to the user as a summary of the state of the build.
+ *
+ * @example 2018-01-20T23:27:25.000Z
+ */
+ lastUpdated: string;
+ /**
+ * @description The Jira issue keys to associate the build information with.
+ *
+ * You are free to associate issue keys in any way you like. However, we recommend that you use the name
+ * of the branch the build was executed on, and extract issue keys from that name using a simple regex. This has
+ * the advantage that it provides an intuitive association of builds to issue keys.
+ */
+ issueKeys: string[];
+ /**
+ * TestInfo
+ * @description Information about tests that were executed during a build.
+ */
+ testInfo?: {
+ /**
+ * Format: int64
+ * @description The total number of tests considered during a build.
+ *
+ * @example 150
+ */
+ totalNumber: number;
+ /**
+ * Format: int64
+ * @description The number of tests that passed during a build.
+ *
+ * @example 145
+ */
+ numberPassed: number;
+ /**
+ * Format: int64
+ * @description The number of tests that failed during a build.
+ *
+ * @example 5
+ */
+ numberFailed: number;
+ /**
+ * Format: int64
+ * @description The number of tests that were skipped during a build.
+ *
+ * @default 0
+ * @example 0
+ */
+ numberSkipped?: number;
+ };
+ /** @description Optional information that links a build to a commit, branch etc. */
+ references?: {
+ /**
+ * BuildCommitReference
+ * @description Details about the commit the build was run against.
+ */
+ commit?: {
+ /**
+ * @description The ID of the commit. E.g. for a Git repository this would be the SHA1 hash.
+ *
+ * @example 08cd9c26b2b8d7cf6e6af6b49da8895d065c259f
+ */
+ id: string;
+ /**
+ * @description An identifier for the repository containing the commit.
+ *
+ * In most cases this should be the URL of the repository in the SCM provider.
+ *
+ * For cases where the build was executed against a local repository etc. this should be some identifier that is
+ * unique to that repository.
+ *
+ * @example https://bitbucket.org/atlassian/biij-vendor-api
+ */
+ repositoryUri: string;
+ };
+ /**
+ * BuildRefReference
+ * @description Details about the ref the build was run on.
+ */
+ ref?: {
+ /**
+ * @description The name of the ref the build ran on
+ *
+ * @example feature/ISSUE-123-some-work
+ */
+ name: string;
+ /**
+ * @description An identifer for the ref.
+ *
+ * In most cases this should be the URL of the tag/branch etc. in the SCM provider.
+ *
+ * For cases where the build was executed against a local repository etc. this should be something that uniquely
+ * identifies the ref.
+ *
+ * @example https://bitbucket.org/atlassian/biij-vendor-api/refs/feature/ISSUE-123-some-work
+ */
+ uri: string;
+ };
+ }[];
+ };
+ };
+ };
+ /** @description Missing a JWT token, or token is invalid. */
+ 401: {
+ content: never;
+ };
+ /**
+ * @description The JWT token used does not correspond to an app that defines the `jiraBuildInfoProvider` module,
+ * or the app does not define the 'READ' scope.
+ */
+ 403: {
+ content: never;
+ };
+ /** @description No build data found for the given key. */
+ 404: {
+ content: never;
+ };
+ /** @description API rate limit has been exceeded. */
+ 429: {
+ content: never;
+ };
+ /** @description Service is unavailable due to maintenance or other reasons. */
+ 503: {
+ content: never;
+ };
+ /** @description An unknown error has occurred. */
+ default: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ };
+ /**
+ * Delete a build by key
+ * @description Delete the build data currently stored for the given `pipelineId` and `buildNumber` combination.
+ *
+ * Deletion is performed asynchronously. The `getBuildByKey` operation can be used to confirm that data has been
+ * deleted successfully (if needed).
+ *
+ * Only Connect apps that define the `jiraBuildInfoProvider` module, and on-premise integrations, can access this resource.
+ * This resource requires the 'DELETE' scope for Connect apps.
+ */
+ deleteBuildByKey: {
+ parameters: {
+ query?: {
+ /**
+ * @deprecated
+ * @description This parameter usage is no longer supported.
+ *
+ * An optional `_updateSequenceNumber` to use to control deletion.
+ *
+ * Only stored data with an `updateSequenceNumber` less than or equal to that provided will be deleted.
+ * This can be used help ensure submit/delete requests are applied correctly if issued close together.
+ */
+ _updateSequenceNumber?: number;
+ };
+ header: {
+ /**
+ * @description All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that corresponds to an app installed in Jira.
+ *
+ * If the Connect JWT token corresponds to an app that does not define `jiraBuildInfoProvider` module it will be rejected with a 403.
+ *
+ * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens.
+ * See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations.
+ */
+ Authorization: string;
+ };
+ path: {
+ /** @description The `pipelineId` of the build to delete. */
+ pipelineId: string;
+ /** @description The `buildNumber` of the build to delete. */
+ buildNumber: number;
+ };
+ };
+ responses: {
+ /** @description Delete has been accepted. Data will eventually be removed from Jira if it exists. */
+ 202: {
+ content: never;
+ };
+ /** @description Missing a JWT token, or token is invalid. */
+ 401: {
+ content: never;
+ };
+ /**
+ * @description The JWT token used does not correspond to an app that defines the `jiraBuildInfoProvider` module,
+ * or the app does not define the 'DELETE' scope.
+ */
+ 403: {
+ content: never;
+ };
+ /** @description API rate limit has been exceeded. */
+ 429: {
+ content: never;
+ };
+ /** @description Service is unavailable due to maintenance or other reasons. */
+ 503: {
+ content: never;
+ };
+ /** @description An unknown error has occurred. */
+ default: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ };
+ /**
+ * Submit Remote Link data
+ * @description Update / insert Remote Link data.
+ *
+ * Remote Links are identified by their ID, existing Remote Link data for the same ID will be replaced if it
+ * exists and the updateSequenceId of existing data is less than the incoming data.
+ *
+ * Submissions are performed asynchronously. Submitted data will eventually be available in Jira; most updates are
+ * available within a short period of time, but may take some time during peak load and/or maintenance times.
+ * The `getRemoteLinkById` operation can be used to confirm that data has been stored successfully (if needed).
+ *
+ * In the case of multiple Remote Links being submitted in one request, each is validated individually prior to
+ * submission. Details of which Remote LInk failed submission (if any) are available in the response object.
+ *
+ * Only Connect apps that define the `jiraRemoteLinkInfoProvider` module can access this resource. This resource
+ * requires the 'WRITE' scope for Connect apps.
+ */
+ submitRemoteLinks: {
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with a Connect JWT token that corresponds to an app installed in Jira.
+ *
+ * If the Connect JWT token corresponds to an app that does not define `jiraRemoteLinkInfoProvider` module it will be rejected with a 403.
+ *
+ * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens.
+ * See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations.
+ */
+ Authorization: string;
+ };
+ };
+ /** @description Remote Links data to submit. */
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * Properties
+ * @description Properties assigned to Remote Link data that can then be used for delete / query operations.
+ *
+ * Examples might be an account or user ID that can then be used to clean up data if an account is removed from
+ * the Provider system.
+ *
+ * Properties are supplied as key/value pairs, a maximum of 5 properties can be supplied, and keys must not
+ * contain ':' or start with '_'.
+ *
+ * @example {
+ * "accountId": "account-234",
+ * "projectId": "project-123"
+ * }
+ */
+ properties?: {
+ [key: string]: string;
+ };
+ /**
+ * @description A list of Remote Links to submit to Jira.
+ *
+ * Each Remote Link may be associated with one or more Jira issue keys, and will be associated with any properties
+ * included in this request.
+ */
+ remoteLinks: {
+ /**
+ * @description The schema version used for this data.
+ *
+ * Placeholder to support potential schema changes in the future.
+ *
+ * @default 1.0
+ * @example 1.0
+ * @enum {string}
+ */
+ schemaVersion?: "1.0";
+ /**
+ * @description The identifier for the Remote Link. Must be unique for a given Provider.
+ *
+ * @example 111-222-333
+ */
+ id: string;
+ /**
+ * Format: int64
+ * @description An ID used to apply an ordering to updates for this Remote Link in the case of out-of-order receipt of
+ * update requests.
+ *
+ * It must be a monotonically increasing number. For example, epoch time could be one way to generate the
+ * `updateSequenceNumber`.
+ *
+ * Updates for a Remote Link that is received with an `updateSqeuenceNumber` less than or equal to what is currently
+ * stored will be ignored.
+ *
+ * @example 1523494301448
+ */
+ updateSequenceNumber: number;
+ /**
+ * @description The human-readable name for the Remote Link.
+ *
+ * Will be shown in the UI.
+ *
+ * @example Remote Link #42
+ */
+ displayName: string;
+ /**
+ * Format: uri
+ * @description The URL to this Remote Link in your system.
+ */
+ url: string;
+ /**
+ * @description The type of the Remote Link. The current supported types are 'document', 'alert', 'test',
+ * 'security', 'logFile', 'prototype', 'coverage', 'bugReport' and 'other'
+ *
+ * @example security
+ * @enum {string}
+ */
+ type:
+ | "document"
+ | "alert"
+ | "test"
+ | "security"
+ | "logFile"
+ | "prototype"
+ | "coverage"
+ | "bugReport"
+ | "other";
+ /**
+ * @description An optional description to attach to this Remote Link.
+ *
+ * This may be anything that makes sense in your system.
+ *
+ * @example Remote Link #42 with more information in this description
+ */
+ description?: string;
+ /**
+ * Format: date-time
+ * @description The last-updated timestamp to present to the user as a summary of when Remote Link was last updated.
+ *
+ * @example 2018-01-20T23:27:25.000Z
+ */
+ lastUpdated: string;
+ /** @description The entities to associate the Remote Link information with. */
+ associations?: (
+ | {
+ /**
+ * @description Defines the asssociation type.
+ *
+ * @example issueKeys
+ * @enum {string}
+ */
+ associationType: "issueKeys";
+ /**
+ * @description The Jira issue keys to associate the Remote Link information with.
+ *
+ * The number of values counted across all associationTypes (issueKeys,
+ * issueIdOrKeys and serviceIdOrKeys) must not exceed a limit of 500.
+ */
+ values: string[];
+ }
+ | {
+ /**
+ * @description Defines the asssociation type.
+ *
+ * @example serviceIdOrKeys
+ * @enum {string}
+ */
+ associationType: "serviceIdOrKeys";
+ /**
+ * @description The service id or keys to associate the Remote Link information with.
+ *
+ * The number of values counted across all associationTypes (issueKeys,
+ * issueIdOrKeys and serviceIdOrKeys) must not exceed a limit of 500.
+ */
+ values: string[];
+ }
+ )[];
+ /**
+ * RemoteLinkStatus
+ * @description The status of a Remote Link.
+ */
+ status?: {
+ /**
+ * @description Appearance is a fixed set of appearance types affecting the colour
+ * of the status lozenge in the UI. The colours they correspond to are
+ * equivalent to atlaskit's [Lozenge](https://atlaskit.atlassian.com/packages/core/lozenge) component.
+ *
+ * @example inprogress
+ * @enum {string}
+ */
+ appearance: "default" | "inprogress" | "moved" | "new" | "removed" | "prototype" | "success";
+ /**
+ * @description The human-readable description for the Remote Link status.
+ *
+ * Will be shown in the UI.
+ *
+ * @example ANOMALOUS
+ */
+ label: string;
+ };
+ /**
+ * @description Optional list of actionIds. They are associated with the actions the provider is able to provide when they
+ * registered. Indicates which actions this Remote Link has.
+ *
+ * If any actions have a templateUrl that requires string substitution, then `attributeMap` must be passed in.
+ *
+ * @example [
+ * "action-111-222-333",
+ * "action-444-555-666"
+ * ]
+ */
+ actionIds?: string[];
+ /**
+ * @description Map of key/values (string to string mapping). This is used to build the urls for actions from the
+ * templateUrl the provider registered their available actions with.
+ */
+ attributeMap?: {
+ [key: string]: string;
+ };
+ }[];
+ /**
+ * ProviderMetadata
+ * @description Information about the provider. This is useful for auditing, logging, debugging, and other internal uses. It is
+ * not considered private information. Hence, it may not contain personally identifiable information.
+ */
+ providerMetadata?: {
+ /**
+ * @description An optional name of the source of the Remote Links data.
+ * @example Opsgenie 6.10.2
+ */
+ product?: string;
+ };
+ };
+ };
+ };
+ responses: {
+ /**
+ * @description Submission accepted. Each submitted Remote Link that is of a valid format will be eventually available in
+ * Jira.
+ *
+ * Details of which Remote Links were submitted and which failed submission (due to data format problems etc.)
+ * are available in the response object.
+ */
+ 202: {
+ content: {
+ "application/json": {
+ /**
+ * @description The IDs of Remote Links that have been accepted for submission.
+ *
+ * A Remote Link may be rejected if it was only associated with unknown issue keys, unknown service IDs, or if
+ * the submitted data for that Remote Link does not match the required schema.
+ *
+ * Note that a Remote Link that isn't updated due to it's `updateSequenceNumber` being out of order is not
+ * considered a failed submission.
+ *
+ * @example [
+ * "111-222-333",
+ * "444-555-666"
+ * ]
+ */
+ acceptedRemoteLinks?: string[];
+ /**
+ * @description Details of Remote Links that have not been accepted for submission, usually due to a problem with the request data.
+ *
+ * A Remote Link may be rejected if it was only associated with unknown issue keys, unknown service IDs, or
+ * if the submitted data for the Remote Link does not match the required schema.
+ *
+ * The object (if present) will be keyed by Remote Link ID and include any errors associated with that
+ * Remote Link that have prevented it being submitted.
+ */
+ rejectedRemoteLinks?: {
+ [key: string]: {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ /** @description Issue keys or services IDs or keys that are not known on this Jira instance (if any). */
+ unknownAssociations?: (
+ | {
+ /**
+ * @description Defines the asssociation type.
+ *
+ * @example issueKeys
+ * @enum {string}
+ */
+ associationType: "issueKeys";
+ /**
+ * @description The Jira issue keys to associate the Remote Link information with.
+ *
+ * The number of values counted across all associationTypes (issueKeys,
+ * issueIdOrKeys and serviceIdOrKeys) must not exceed a limit of 500.
+ */
+ values: string[];
+ }
+ | {
+ /**
+ * @description Defines the asssociation type.
+ *
+ * @example serviceIdOrKeys
+ * @enum {string}
+ */
+ associationType: "serviceIdOrKeys";
+ /**
+ * @description The service id or keys to associate the Remote Link information with.
+ *
+ * The number of values counted across all associationTypes (issueKeys,
+ * issueIdOrKeys and serviceIdOrKeys) must not exceed a limit of 500.
+ */
+ values: string[];
+ }
+ )[];
+ };
+ };
+ };
+ /**
+ * @description Request has incorrect format.
+ *
+ * Note that in the case of an individual Remote Link having an invalid format (rather than the request as a
+ * whole) the response for the request will be a 202 and details of the invalid Remote Link will be contained
+ * in the response object.
+ */
+ 400: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ /** @description Missing a JWT token, or token is invalid. */
+ 401: {
+ content: never;
+ };
+ /**
+ * @description The JWT token used does not correspond to an app that defines the `jiraRemoteLinkInfoProvider` module,
+ * or the app does not define the 'WRITE' scope.
+ */
+ 403: {
+ content: never;
+ };
+ /** @description Data is too large. Submit fewer Remote Links in each payload. */
+ 413: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ /** @description API rate limit has been exceeded. */
+ 429: {
+ content: never;
+ };
+ /** @description Service is unavailable due to maintenance or other reasons. */
+ 503: {
+ content: never;
+ };
+ /** @description An unknown error has occurred. */
+ default: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ };
+ /**
+ * Delete Remote Links by Property
+ * @description Bulk delete all Remote Links data that match the given request.
+ *
+ * One or more query params must be supplied to specify Properties to delete by.
+ * Optional param `_updateSequenceNumber` is no longer supported. If more than one Property is provided,
+ * data will be deleted that matches ALL of the Properties (e.g. treated as an AND).
+ *
+ * See the documentation for the `submitRemoteLinks` operation for more details.
+ *
+ * e.g. DELETE /bulkByProperties?accountId=account-123&repoId=repo-345
+ *
+ * Deletion is performed asynchronously. The `getRemoteLinkById` operation can be used to confirm that data has been
+ * deleted successfully (if needed).
+ *
+ * Only Connect apps that define the `jiraRemoteLinkInfoProvider` module, and on-premise integrations, can access this resource.
+ * This resource requires the 'DELETE' scope for Connect apps.
+ */
+ deleteRemoteLinksByProperty: {
+ parameters: {
+ query?: {
+ /**
+ * @deprecated
+ * @description This parameter usage is no longer supported.
+ *
+ * An optional `_updateSequenceNumber` to use to control deletion.
+ *
+ * Only stored data with an `updateSequenceNumber` less than or equal to that provided will be deleted.
+ * This can be used help ensure submit/delete requests are applied correctly if issued close together.
+ *
+ * If not provided, all stored data that matches the request will be deleted.
+ */
+ _updateSequenceNumber?: number;
+ /**
+ * @description Free-form query parameters to specify which properties to delete by. Properties refer to the arbitrary
+ * information the provider tagged Remote Links with previously.
+ *
+ * For example, if the provider previously tagged a remote link with accountId:
+ * "properties": {
+ * "accountId": "account-123"
+ * }
+ *
+ * And now they want to delete Remote Links in bulk by that specific accountId as follows:
+ * e.g. DELETE /bulkByProperties?accountId=account-123
+ */
+ params?: Record;
+ };
+ header: {
+ /**
+ * @description All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that
+ * corresponds to an app installed in Jira.
+ *
+ * If the Connect JWT token corresponds to an app that does not define `jiraRemoteLinkInfoProvider` module it will be rejected with a 403.
+ *
+ * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens.
+ * See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations.
+ */
+ Authorization: string;
+ };
+ };
+ responses: {
+ /** @description Delete accepted. Data will eventually be removed from Jira. */
+ 202: {
+ content: never;
+ };
+ /** @description Request has incorrect format (e.g. missing at least one Property param). */
+ 400: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ /** @description Missing a JWT token, or token is invalid. */
+ 401: {
+ content: never;
+ };
+ /**
+ * @description The JWT token used does not correspond to an app that defines the `jiraRemoteLinkInfoProvider` module,
+ * or the app does not define the 'DELETE' scope.
+ */
+ 403: {
+ content: never;
+ };
+ /** @description API rate limit has been exceeded. */
+ 429: {
+ content: never;
+ };
+ /** @description Service is unavailable due to maintenance or other reasons. */
+ 503: {
+ content: never;
+ };
+ /** @description An unknown error has occurred. */
+ default: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ };
+ /**
+ * Get a Remote Link by ID
+ * @description Retrieve the currently stored Remote Link data for the given ID.
+ *
+ * The result will be what is currently stored, ignoring any pending updates or deletes.
+ *
+ * Only Connect apps that define the `jiraRemoteLinkInfoProvider` module, and on-premise integrations, can access this resource.
+ * This resource requires the 'READ' scope for Connect apps.
+ */
+ getRemoteLinkById: {
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that
+ * corresponds to an app installed in Jira.
+ *
+ * If the Connect JWT token corresponds to an app that does not define `jiraRemoteLinkInfoProvider` module it will be rejected with a 403.
+ *
+ * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens.
+ * See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations.
+ */
+ Authorization: string;
+ };
+ path: {
+ /** @description The ID of the Remote Link to fetch. */
+ remoteLinkId: string;
+ };
+ };
+ responses: {
+ /** @description The Remote Link data currently stored for the given ID. */
+ 200: {
+ content: {
+ "application/json": {
+ /**
+ * @description The schema version used for this data.
+ *
+ * Placeholder to support potential schema changes in the future.
+ *
+ * @default 1.0
+ * @example 1.0
+ * @enum {string}
+ */
+ schemaVersion?: "1.0";
+ /**
+ * @description The identifier for the Remote Link. Must be unique for a given Provider.
+ *
+ * @example 111-222-333
+ */
+ id: string;
+ /**
+ * Format: int64
+ * @description An ID used to apply an ordering to updates for this Remote Link in the case of out-of-order receipt of
+ * update requests.
+ *
+ * It must be a monotonically increasing number. For example, epoch time could be one way to generate the
+ * `updateSequenceNumber`.
+ *
+ * Updates for a Remote Link that is received with an `updateSqeuenceNumber` less than or equal to what is currently
+ * stored will be ignored.
+ *
+ * @example 1523494301448
+ */
+ updateSequenceNumber: number;
+ /**
+ * @description The human-readable name for the Remote Link.
+ *
+ * Will be shown in the UI.
+ *
+ * @example Remote Link #42
+ */
+ displayName: string;
+ /**
+ * Format: uri
+ * @description The URL to this Remote Link in your system.
+ */
+ url: string;
+ /**
+ * @description The type of the Remote Link. The current supported types are 'document', 'alert', 'test',
+ * 'security', 'logFile', 'prototype', 'coverage', 'bugReport' and 'other'
+ *
+ * @example security
+ * @enum {string}
+ */
+ type:
+ | "document"
+ | "alert"
+ | "test"
+ | "security"
+ | "logFile"
+ | "prototype"
+ | "coverage"
+ | "bugReport"
+ | "other";
+ /**
+ * @description An optional description to attach to this Remote Link.
+ *
+ * This may be anything that makes sense in your system.
+ *
+ * @example Remote Link #42 with more information in this description
+ */
+ description?: string;
+ /**
+ * Format: date-time
+ * @description The last-updated timestamp to present to the user as a summary of when Remote Link was last updated.
+ *
+ * @example 2018-01-20T23:27:25.000Z
+ */
+ lastUpdated: string;
+ /** @description The entities to associate the Remote Link information with. */
+ associations?: (
+ | {
+ /**
+ * @description Defines the asssociation type.
+ *
+ * @example issueKeys
+ * @enum {string}
+ */
+ associationType: "issueKeys";
+ /**
+ * @description The Jira issue keys to associate the Remote Link information with.
+ *
+ * The number of values counted across all associationTypes (issueKeys,
+ * issueIdOrKeys and serviceIdOrKeys) must not exceed a limit of 500.
+ */
+ values: string[];
+ }
+ | {
+ /**
+ * @description Defines the asssociation type.
+ *
+ * @example serviceIdOrKeys
+ * @enum {string}
+ */
+ associationType: "serviceIdOrKeys";
+ /**
+ * @description The service id or keys to associate the Remote Link information with.
+ *
+ * The number of values counted across all associationTypes (issueKeys,
+ * issueIdOrKeys and serviceIdOrKeys) must not exceed a limit of 500.
+ */
+ values: string[];
+ }
+ )[];
+ /**
+ * RemoteLinkStatus
+ * @description The status of a Remote Link.
+ */
+ status?: {
+ /**
+ * @description Appearance is a fixed set of appearance types affecting the colour
+ * of the status lozenge in the UI. The colours they correspond to are
+ * equivalent to atlaskit's [Lozenge](https://atlaskit.atlassian.com/packages/core/lozenge) component.
+ *
+ * @example inprogress
+ * @enum {string}
+ */
+ appearance: "default" | "inprogress" | "moved" | "new" | "removed" | "prototype" | "success";
+ /**
+ * @description The human-readable description for the Remote Link status.
+ *
+ * Will be shown in the UI.
+ *
+ * @example ANOMALOUS
+ */
+ label: string;
+ };
+ /**
+ * @description Optional list of actionIds. They are associated with the actions the provider is able to provide when they
+ * registered. Indicates which actions this Remote Link has.
+ *
+ * If any actions have a templateUrl that requires string substitution, then `attributeMap` must be passed in.
+ *
+ * @example [
+ * "action-111-222-333",
+ * "action-444-555-666"
+ * ]
+ */
+ actionIds?: string[];
+ /**
+ * @description Map of key/values (string to string mapping). This is used to build the urls for actions from the
+ * templateUrl the provider registered their available actions with.
+ */
+ attributeMap?: {
+ [key: string]: string;
+ };
+ };
+ };
+ };
+ /** @description Missing a JWT token, or token is invalid. */
+ 401: {
+ content: never;
+ };
+ /**
+ * @description The JWT token used does not correspond to an app that defines the `jiraRemoteLinkInfoProvider` module,
+ * or the app does not define the 'READ' scope.
+ */
+ 403: {
+ content: never;
+ };
+ /** @description No Remote Link data found for the given ID. */
+ 404: {
+ content: never;
+ };
+ /** @description API rate limit has been exceeded. */
+ 429: {
+ content: never;
+ };
+ /** @description Service is unavailable due to maintenance or other reasons. */
+ 503: {
+ content: never;
+ };
+ /** @description An unknown error has occurred. */
+ default: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ };
+ /**
+ * Delete a Remote Link by ID
+ * @description Delete the Remote Link data currently stored for the given ID.
+ *
+ * Deletion is performed asynchronously. The `getRemoteLinkById` operation can be used to confirm that data has been
+ * deleted successfully (if needed).
+ *
+ * Only Connect apps that define the `jiraRemoteLinkInfoProvider` module, and on-premise integrations, can access this resource.
+ * This resource requires the 'DELETE' scope for Connect apps.
+ */
+ deleteRemoteLinkById: {
+ parameters: {
+ query?: {
+ /**
+ * @deprecated
+ * @description This parameter usage is no longer supported.
+ *
+ * An optional `_updateSequenceNumber` to use to control deletion.
+ *
+ * Only stored data with an `updateSequenceNumber` less than or equal to that provided will be deleted.
+ * This can be used help ensure submit/delete requests are applied correctly if issued close together.
+ */
+ _updateSequenceNumber?: number;
+ };
+ header: {
+ /**
+ * @description All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that
+ * corresponds to an app installed in Jira.
+ *
+ * If the Connect JWT token corresponds to an app that does not define `jiraRemoteLinkInfoProvider` module it will be rejected with a 403.
+ *
+ * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens.
+ * See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations.
+ */
+ Authorization: string;
+ };
+ path: {
+ /** @description The ID of the Remote Link to fetch. */
+ remoteLinkId: string;
+ };
+ };
+ responses: {
+ /** @description Delete has been accepted. Data will eventually be removed from Jira if it exists. */
+ 202: {
+ content: never;
+ };
+ /** @description Missing a JWT token, or token is invalid. */
+ 401: {
+ content: never;
+ };
+ /**
+ * @description The JWT token used does not correspond to an app that defines the `jiraRemoteLinkInfoProvider` module,
+ * or the app does not define the 'DELETE' scope.
+ */
+ 403: {
+ content: never;
+ };
+ /** @description API rate limit has been exceeded. */
+ 429: {
+ content: never;
+ };
+ /** @description Service is unavailable due to maintenance or other reasons. */
+ 503: {
+ content: never;
+ };
+ /** @description An unknown error has occurred. */
+ default: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ };
+ /**
+ * Submit Security Workspaces to link
+ * @description Insert Security Workspace IDs to establish a relationship between them and the Jira site the app is installed on. If a relationship between the workspace ID and Jira already exists then the workspace ID will be ignored and Jira will process the rest of the entries.
+ *
+ * Only Connect apps that define the `jiraSecurityInfoProvider` module can access this resource.
+ * This resource requires the 'WRITE' scope for Connect apps.
+ */
+ submitWorkspaces: {
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with a Connect JWT token that corresponds to the Provider app installed in Jira.
+ *
+ * If the JWT token corresponds to an app that does not define the Security Information module it will be rejected with a 403.
+ *
+ * Read [understanding jwt](https://developer.atlassian.com/blog/2015/01/understanding-jwt/) for more details.
+ */
+ Authorization: string;
+ };
+ };
+ /** @description Security Workspace IDs to submit. */
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * Security Workspace IDs
+ * @description The IDs of Security Workspaces to link to this Jira site. These must follow this regex pattern: `[a-zA-Z0-9\\-_.~@:{}=]+(\/[a-zA-Z0-9\\-_.~@:{}=]+)*`
+ *
+ * @example [
+ * "111-222-333",
+ * "444-555-666"
+ * ]
+ */
+ workspaceIds: string[];
+ };
+ };
+ };
+ responses: {
+ /** @description Submission accepted. Each submitted Security Workspace ID will be linked to Jira. */
+ 202: {
+ content: never;
+ };
+ /** @description Request has incorrect format. */
+ 400: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ /** @description Missing a JWT token, or token is invalid. */
+ 401: {
+ content: never;
+ };
+ /**
+ * @description The JWT token used does not correspond to an app that defines the `jiraSecurityInfoProvider` module,
+ * or the app does not define the 'WRITE' scope.
+ */
+ 403: {
+ content: never;
+ };
+ /** @description Set of Ids is too large. Submit fewer Ids in each payload. */
+ 413: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ /** @description API rate limit has been exceeded. */
+ 429: {
+ content: never;
+ };
+ /** @description Service is unavailable due to maintenance or other reasons. */
+ 503: {
+ content: never;
+ };
+ /** @description An unknown error has occurred. */
+ default: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ };
+ /**
+ * Delete linked Security Workspaces
+ * @description Bulk delete all linked Security Workspaces that match the given request.
+ *
+ * Only Connect apps that define the `jiraSecurityInfoProvider` module can access this resource.
+ * This resource requires the 'DELETE' scope for Connect apps.
+ *
+ * e.g. DELETE /bulk?workspaceIds=111-222-333,444-555-666
+ */
+ deleteLinkedWorkspaces: {
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with a Connect JWT token that corresponds to the Provider app installed in Jira.
+ *
+ * If the JWT token corresponds to an app that does not define the Security Information module it will be rejected with a 403.
+ *
+ * Read [understanding jwt](https://developer.atlassian.com/blog/2015/01/understanding-jwt/) for more details.
+ */
+ Authorization: string;
+ };
+ };
+ responses: {
+ /** @description Delete accepted. Workspaces and related data will eventually be removed from Jira. */
+ 202: {
+ content: never;
+ };
+ /** @description Request has incorrect format. */
+ 400: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ /** @description Missing a JWT token, or token is invalid. */
+ 401: {
+ content: never;
+ };
+ /**
+ * @description The JWT token used does not correspond to an app that defines the `jiraSecurityInfoProvider` module,
+ * or the app does not define the 'DELETE' scope.
+ */
+ 403: {
+ content: never;
+ };
+ /** @description API rate limit has been exceeded. */
+ 429: {
+ content: never;
+ };
+ /** @description Service is unavailable due to maintenance or other reasons. */
+ 503: {
+ content: never;
+ };
+ /** @description An unknown error has occurred. */
+ default: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ };
+ /**
+ * Get linked Security Workspaces
+ * @description Retrieve all Security Workspaces linked with the Jira site.
+ *
+ * The result will be what is currently stored, ignoring any pending updates or deletes.
+ *
+ * Only Connect apps that define the `jiraSecurityInfoProvider` module can access this resource.
+ * This resource requires the 'READ' scope for Connect apps.
+ */
+ getLinkedWorkspaces: {
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with a Connect JWT token that corresponds to the Provider app installed in Jira.
+ *
+ * If the JWT token corresponds to an app that does not define the Security Information module it will be rejected with a 403.
+ *
+ * Read more about JWT [here](https://developer.atlassian.com/blog/2015/01/understanding-jwt/).
+ */
+ Authorization: string;
+ };
+ };
+ responses: {
+ /** @description A list of all stored workspace IDs. */
+ 200: {
+ content: {
+ "application/json": {
+ /**
+ * Security Workspace IDs
+ * @description The IDs of Security Workspaces that are linked to this Jira site.
+ *
+ * @example [
+ * "111-222-333",
+ * "444-555-666"
+ * ]
+ */
+ workspaceIds: string[];
+ };
+ };
+ };
+ /** @description Missing a JWT token, or token is invalid. */
+ 401: {
+ content: never;
+ };
+ /**
+ * @description The JWT token used does not correspond to an app that defines the `jiraSecurityInfoProvider` module,
+ * or the app does not define the 'READ' scope.
+ */
+ 403: {
+ content: never;
+ };
+ /** @description No data found for the given workspace ID. */
+ 404: {
+ content: never;
+ };
+ /** @description API rate limit has been exceeded. */
+ 429: {
+ content: never;
+ };
+ /** @description Service is unavailable due to maintenance or other reasons. */
+ 503: {
+ content: never;
+ };
+ /** @description An unknown error has occurred. */
+ default: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ };
+ /**
+ * Get a linked Security Workspace by ID
+ * @description Retrieve a specific Security Workspace linked to the Jira site for the given workspace ID.
+ *
+ * The result will be what is currently stored, ignoring any pending updates or deletes.
+ *
+ * Only Connect apps that define the `jiraSecurityInfoProvider` module can access this resource.
+ * This resource requires the 'READ' scope for Connect apps.
+ */
+ getLinkedWorkspaceById: {
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with a Connect JWT token that corresponds to the Provider app installed in Jira.
+ *
+ * If the JWT token corresponds to an app that does not define the Security Information module it will be rejected with a 403.
+ *
+ * Read more about JWT [here](https://developer.atlassian.com/blog/2015/01/understanding-jwt/).
+ */
+ Authorization: string;
+ };
+ path: {
+ /** @description The ID of the workspace to fetch. */
+ workspaceId: string;
+ };
+ };
+ responses: {
+ /** @description The Security Workspace information stored for the given ID. */
+ 200: {
+ content: {
+ "application/json": {
+ /**
+ * @description The Security Workspace ID
+ *
+ * @example 111-222-333
+ */
+ workspaceId: string;
+ /**
+ * Format: date-time
+ * @description Latest date and time that the Security Workspace was updated in Jira.
+ *
+ * @example 2020-01-17T09:30:00Z
+ */
+ updatedAt: string;
+ };
+ };
+ };
+ /** @description Missing a JWT token, or token is invalid. */
+ 401: {
+ content: never;
+ };
+ /**
+ * @description The JWT token used does not correspond to an app that defines the `jiraSecurityInfoProvider` module,
+ * or the app does not define the 'READ' scope.
+ */
+ 403: {
+ content: never;
+ };
+ /** @description No data found for the given workspace ID. */
+ 404: {
+ content: never;
+ };
+ /** @description API rate limit has been exceeded. */
+ 429: {
+ content: never;
+ };
+ /** @description Service is unavailable due to maintenance or other reasons. */
+ 503: {
+ content: never;
+ };
+ /** @description An unknown error has occurred. */
+ default: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ };
+ /**
+ * Submit Vulnerability data
+ * @description Update / Insert Vulnerability data.
+ *
+ * Vulnerabilities are identified by their ID, any existing Vulnerability data with the same ID will be replaced if it exists and the updateSequenceNumber of the existing data is less than the incoming data.
+ *
+ * Submissions are performed asynchronously. Most updates are available within a short period of time but may take some time during peak load and/or maintenance times. The GET vulnerability endpoint can be used to confirm that data has been stored successfully (if needed).
+ *
+ * In the case of multiple Vulnerabilities being submitted in one request, each is validated individually prior to submission. Details of Vulnerabilities that failed submission (if any) are available in the response object.
+ *
+ * A maximum of 1000 vulnerabilities can be submitted in one request.
+ *
+ * Only Connect apps that define the `jiraSecurityInfoProvider` module can access this resource.
+ * This resource requires the 'WRITE' scope for Connect apps.
+ */
+ submitVulnerabilities: {
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with a Connect JWT token that corresponds to the Provider app installed in Jira.
+ *
+ * If the JWT token corresponds to an app that does not define the Security Information module it will be rejected with a 403.
+ *
+ * Read more about JWT [here](https://developer.atlassian.com/blog/2015/01/understanding-jwt/).
+ */
+ Authorization: string;
+ };
+ };
+ /** @description Vulnerability data to submit. */
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * @description Indicates the operation being performed by the provider system when sending this data. "NORMAL" - Data received during real-time, user-triggered actions (e.g. user closed or updated a vulnerability). "SCAN" - Data sent through some automated process (e.g. some periodically scheduled repository scan). "BACKFILL" - Data received while backfilling existing data (e.g. pushing historical vulnerabilities when re-connect a workspace). Default is "NORMAL". "NORMAL" traffic has higher priority but tighter rate limits, "SCAN" traffic has medium priority and looser limits, "BACKFILL" has lower priority and much looser limits
+ *
+ * @example SCAN
+ * @enum {string}
+ */
+ operationType?: "NORMAL" | "SCAN" | "BACKFILL";
+ /**
+ * Properties
+ * @description Properties assigned to vulnerability data that can then be used for delete / query operations.
+ *
+ * Examples might be an account or user ID that can then be used to clean up data if an account is removed from the Provider system.
+ *
+ * Properties are supplied as key/value pairs, and a maximum of 5 properties can be supplied, keys cannot contain ':' or start with '_'.
+ *
+ * @example {
+ * "accountId": "account-234",
+ * "projectId": "project-123"
+ * }
+ */
+ properties?: {
+ [key: string]: string;
+ };
+ vulnerabilities: {
+ /**
+ * @description The VulnerabilityData schema version used for this vulnerability data.
+ *
+ * Placeholder to support potential schema changes in the future.
+ *
+ * @default 1.0
+ * @example 1.0
+ * @enum {string}
+ */
+ schemaVersion: "1.0";
+ /**
+ * @description The identifier for the Vulnerability. Must be unique for a given Provider.
+ *
+ * @example 111-222-333
+ */
+ id: string;
+ /**
+ * Format: int64
+ * @description An ID used to apply an ordering to updates for this Vulnerability in the case of out-of-order receipt of update requests.
+ *
+ * This can be any monotonically increasing number. A suggested implementation is to use epoch millis from the Provider system, but other alternatives are valid (e.g. a Provider could store a counter against each Vulnerability and increment that on each update to Jira).
+ *
+ * Updates for a Vulnerability that are received with an updateSequenceId lower than what is currently stored will be ignored.
+ *
+ * @example 1523494301448
+ */
+ updateSequenceNumber: number;
+ /**
+ * @description The identifier of the Container where this Vulnerability was found. Must be unique for a given Provider. This must follow this regex pattern: `[a-zA-Z0-9\\-_.~@:{}=]+(/[a-zA-Z0-9\\-_.~@:{}=]+)*`
+ *
+ * @example 111-222-333
+ */
+ containerId: string;
+ /**
+ * @description The human-readable name for the Vulnerability. Will be shown in the UI.
+ *
+ * If not provided, will use the ID for display.
+ *
+ * @example curl/libcurl3 - Buffer Override
+ */
+ displayName: string;
+ /**
+ * @description A description of the issue in markdown format that will be shown in the UI and used when creating Jira Issues. HTML tags are not supported in the markdown format. For creating a new line `\n` can be used. Read more about the accepted markdown transformations [here](https://atlaskit.atlassian.com/packages/editor/editor-markdown-transformer).
+ *
+ * @example ## Overview
+ *
+ *
+ * Affected versions of this package are vulnerable to MeltLeak
+ */
+ description: string;
+ /**
+ * Format: uri
+ * @description A URL users can use to link to a summary view of this vulnerability, if appropriate.
+ *
+ * This could be any location that makes sense in the Provider system (e.g. if the summary information comes from a specific project, it might make sense to link the user to the vulnerability in that project).
+ *
+ * @example https://example.com/project/CWE-123/summary
+ */
+ url: string;
+ /**
+ * @description The type of Vulnerability detected.
+ * @example sca
+ * @enum {string}
+ */
+ type: "sca" | "sast" | "dast" | "unknown";
+ /**
+ * Format: date-time
+ * @description The timestamp to present to the user that shows when the Vulnerability was introduced.
+ *
+ * Expected format is an RFC3339 formatted string.
+ *
+ * @example 2018-01-20T23:27:25.000Z
+ */
+ introducedDate: string;
+ /**
+ * Format: date-time
+ * @description The last-updated timestamp to present to the user the last time the Vulnerability was updated.
+ *
+ * Expected format is an RFC3339 formatted string.
+ *
+ * @example 2018-01-20T23:27:25.000Z
+ */
+ lastUpdated: string;
+ /**
+ * VulnerabilitySeverity
+ * @description Severity information for a single Vulnerability.
+ *
+ * This is the severity information that will be presented to the user on e.g. the Jira Security screen.
+ */
+ severity: {
+ /**
+ * @description The severity level of the Vulnerability.
+ * @example critical
+ * @enum {string}
+ */
+ level: "critical" | "high" | "medium" | "low" | "unknown";
+ };
+ /** @description The identifying information for the Vulnerability. */
+ identifiers?: {
+ /**
+ * @description The display name of the Vulnerability identified.
+ *
+ * @example CWE-123
+ */
+ displayName: string;
+ /**
+ * Format: uri
+ * @description A URL users can use to link to the definition of the Vulnerability identified.
+ *
+ * @example https://cwe.mitre.org/data/definitions/123.html
+ */
+ url: string;
+ }[];
+ /**
+ * VulnerabilityStatus
+ * @description The current status of the Vulnerability.
+ *
+ * @example open
+ * @enum {string}
+ */
+ status: "open" | "closed" | "ignored" | "unknown";
+ /**
+ * VulnerabilityAdditionalInfo
+ * @description Extra information (optional). This data will be shown in the security feature under the vulnerability displayName.
+ */
+ additionalInfo?: {
+ /**
+ * @description The content of the additionalInfo.
+ *
+ * @example More information on the vulnerability, as a string
+ */
+ content: string;
+ /**
+ * Format: uri
+ * @description Optional URL linking to the information
+ *
+ * @example https://example.com/project/CWE-123/additionalInfo
+ */
+ url?: string;
+ };
+ /** @description The associations (e.g. Jira issue) to add in addition to the currently stored associations of the Security Vulnerability. */
+ addAssociations?: {
+ /**
+ * @description Defines the association type.
+ *
+ * @example issueIdOrKeys
+ * @enum {string}
+ */
+ associationType: "issueIdOrKeys";
+ /**
+ * @description The Jira issue id or keys to associate the Security information with.
+ *
+ * The number of values counted across all associationTypes (issueIdOrKeys) must not exceed a limit of 500.
+ */
+ values: string[];
+ }[];
+ /** @description The associations (e.g. Jira issue) to remove from currently stored associations of the Security Vulnerability. */
+ removeAssociations?: {
+ /**
+ * @description Defines the association type.
+ *
+ * @example issueIdOrKeys
+ * @enum {string}
+ */
+ associationType: "issueIdOrKeys";
+ /**
+ * @description The Jira issue id or keys to associate the Security information with.
+ *
+ * The number of values counted across all associationTypes (issueIdOrKeys) must not exceed a limit of 500.
+ */
+ values: string[];
+ }[];
+ /**
+ * Format: date-time
+ * @description An ISO-8601 Date-time string representing the last time the provider updated associations on this entity.
+ *
+ * Expected format is an RFC3339 formatted string.
+ *
+ * @example 2023-11-02T23:27:25.000Z
+ */
+ associationsLastUpdated?: string;
+ /**
+ * Format: int64
+ * @description A sequence number to compare when writing entity associations to the database.
+ *
+ * This can be any monotonically increasing number. A highly recommended implementation is to use epoch millis.
+ *
+ * If it is not provided it will default to being equal to the corresponding entity's `updateSequenceNumber`.
+ *
+ * Associations are written following a LastWriteWins strategy, association that are received with an associationsUpdateSequenceNumber lower than what is currently stored will be ignored.
+ *
+ * @example 1523494301448
+ */
+ associationsUpdateSequenceNumber?: number;
+ }[];
+ /**
+ * ProviderMetadata
+ * @description Information about the provider. This is useful for auditing, logging, debugging,
+ * and other internal uses. Information in this property is not considered private, so it should not contain personally identifiable information
+ */
+ providerMetadata?: {
+ /**
+ * @description An optional name of the source of the vulnerabilities.
+ * @example Atlassian Security Platform 2.1.0
+ */
+ product?: string;
+ };
+ };
+ };
+ };
+ responses: {
+ /**
+ * @description Submission accepted. Each Vulnerability submitted in a valid format will eventually be available in Jira.
+ *
+ * Details of any Vulnerabilities that were submitted but failed submission (due to data format problems, etc.) are available in the response object.
+ */
+ 202: {
+ content: {
+ "application/json": {
+ /**
+ * @description The IDs of Vulnerabilities that have been accepted for submission.
+ *
+ * A Vulnerability may be rejected if it was only associated with unknown project keys.
+ *
+ * Note that a Vulnerability that isn't updated due to it's updateSequenceNumber being out of order is not considered a failed submission.
+ *
+ * @example [
+ * "111-222-333",
+ * "444-555-666"
+ * ]
+ */
+ acceptedVulnerabilities?: string[];
+ /**
+ * @description Details of Vulnerabilities that have not been accepted for submission, usually due to a problem with the request data.
+ *
+ * The object (if present) will be keyed by Vulnerability ID and include any errors associated with that Vulnerability that have prevented it being submitted.
+ */
+ failedVulnerabilities?: {
+ [key: string]: {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ /**
+ * @description Associations (e.g. Service IDs) that are not known on this Jira instance (if any).
+ *
+ * If a Vulnerability has been associated with any other association other than those in this array it will still be stored against those valid associations.
+ * If a Vulnerability was only associated with the associations in this array, it is deemed to be invalid and it won't be persisted.
+ */
+ unknownAssociations?: {
+ /**
+ * @description Defines the association type.
+ *
+ * @example serviceIdOrKeys
+ * @enum {string}
+ */
+ associationType: "serviceIdOrKeys";
+ /**
+ * @description The service id or keys to associate the Security information with.
+ *
+ * The number of values counted across all associationTypes (serviceIdOrKeys) must not exceed a limit of 500.
+ */
+ values: string[];
+ }[];
+ };
+ };
+ };
+ /**
+ * @description Request has incorrect format.
+ *
+ * Note that in the case of an individual Vulnerability having an invalid format (rather than the request as a whole) the response for the request will be a 202 and details of the invalid Vulnerability will be contained in the response object.
+ */
+ 400: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ /** @description Missing a JWT token, or token is invalid. */
+ 401: {
+ content: never;
+ };
+ /**
+ * @description The JWT token used does not correspond to an app that defines the `jiraSecurityInfoProvider` module,
+ * or the app does not define the 'WRITE' scope.
+ */
+ 403: {
+ content: never;
+ };
+ /** @description Data is too large. Submit fewer Vulnerabilities in each payload. */
+ 413: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ /** @description API rate limit has been exceeded. */
+ 429: {
+ headers: {
+ /** @description The number of remaining possible requests in current rate limit window. */
+ "X-RateLimit-Remaining"?: number;
+ /** @description The date in ISO 8601 format when the rate limit values will be next reset. */
+ "X-RateLimit-Reset"?: string;
+ /** @description The maximum possible requests in a window of one minute. */
+ "X-RateLimit-Limit"?: number;
+ /** @description The number of seconds to wait before making a follow-up request. */
+ "Retry-After"?: number;
+ };
+ content: never;
+ };
+ /** @description Service is unavailable due to maintenance or other reasons. */
+ 503: {
+ content: never;
+ };
+ /** @description An unknown error has occurred. */
+ default: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ };
+ /**
+ * Delete Vulnerabilities by Property
+ * @description Bulk delete all Vulnerabilities that match the given request.
+ *
+ * One or more query params must be supplied to specify Properties to delete by.
+ * If more than one Property is provided, data will be deleted that matches ALL of the Properties (e.g. treated as an AND).
+ * Read the POST bulk endpoint documentation for more details.
+ *
+ * e.g. DELETE /bulkByProperties?accountId=account-123&createdBy=user-456
+ *
+ * Deletion is performed asynchronously. The GET vulnerability endpoint can be used to confirm that data has been deleted successfully (if needed).
+ *
+ * Only Connect apps that define the `jiraSecurityInfoProvider` module can access this resource.
+ * This resource requires the 'DELETE' scope for Connect apps.
+ */
+ deleteVulnerabilitiesByProperty: {
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with a Connect JWT token that corresponds to the Provider app installed in Jira.
+ *
+ * If the JWT token corresponds to an app that does not define Security Information module it will be rejected with a 403.
+ *
+ * Read more about JWT [here](https://developer.atlassian.com/blog/2015/01/understanding-jwt/).
+ */
+ Authorization: string;
+ };
+ };
+ responses: {
+ /** @description Delete accepted. Data will eventually be removed from Jira. */
+ 202: {
+ content: never;
+ };
+ /** @description Request has incorrect format (e.g. missing at least one Property param). */
+ 400: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ /** @description Missing a JWT token, or token is invalid. */
+ 401: {
+ content: never;
+ };
+ /**
+ * @description The JWT token used does not correspond to an app that defines the `jiraSecurityInfoProvider` module,
+ * or the app does not define the 'DELETE' scope.
+ */
+ 403: {
+ content: never;
+ };
+ /** @description API rate limit has been exceeded. */
+ 429: {
+ content: never;
+ };
+ /** @description Service is unavailable due to maintenance or other reasons. */
+ 503: {
+ content: never;
+ };
+ /** @description An unknown error has occurred. */
+ default: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ };
+ /**
+ * Get a Vulnerability by ID
+ * @description Retrieve the currently stored Vulnerability data for the given ID.
+ *
+ * The result will be what is currently stored, ignoring any pending updates or deletes.
+ *
+ * Only Connect apps that define the `jiraSecurityInfoProvider` module can access this resource.
+ * This resource requires the 'READ' scope for Connect apps.
+ */
+ getVulnerabilityById: {
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with a Connect JWT token that corresponds to the Provider app installed in Jira.
+ *
+ * If the JWT token corresponds to an app that does not define Security Information module it will be rejected with a 403.
+ *
+ * Read more about JWT [here](https://developer.atlassian.com/blog/2015/01/understanding-jwt/).
+ */
+ Authorization: string;
+ };
+ path: {
+ /** @description The ID of the Vulnerability to fetch. */
+ vulnerabilityId: string;
+ };
+ };
+ responses: {
+ /** @description The Vulnerability data currently stored for the given ID. */
+ 200: {
+ content: {
+ "application/json": {
+ /**
+ * @description The VulnerabilityData schema version used for this vulnerability data.
+ *
+ * Placeholder to support potential schema changes in the future.
+ *
+ * @default 1.0
+ * @example 1.0
+ * @enum {string}
+ */
+ schemaVersion: "1.0";
+ /**
+ * @description The identifier for the Vulnerability. Must be unique for a given Provider.
+ *
+ * @example 111-222-333
+ */
+ id: string;
+ /**
+ * Format: int64
+ * @description An ID used to apply an ordering to updates for this Vulnerability in the case of out-of-order receipt of update requests.
+ *
+ * This can be any monotonically increasing number. A suggested implementation is to use epoch millis from the Provider system, but other alternatives are valid (e.g. a Provider could store a counter against each Vulnerability and increment that on each update to Jira).
+ *
+ * Updates for a Vulnerability that are received with an updateSequenceId lower than what is currently stored will be ignored.
+ *
+ * @example 1523494301448
+ */
+ updateSequenceNumber: number;
+ /**
+ * @description The identifier of the Container where this Vulnerability was found. Must be unique for a given Provider. This must follow this regex pattern: `[a-zA-Z0-9\\-_.~@:{}=]+(/[a-zA-Z0-9\\-_.~@:{}=]+)*`
+ *
+ * @example 111-222-333
+ */
+ containerId: string;
+ /**
+ * @description The human-readable name for the Vulnerability. Will be shown in the UI.
+ *
+ * If not provided, will use the ID for display.
+ *
+ * @example curl/libcurl3 - Buffer Override
+ */
+ displayName: string;
+ /**
+ * @description A description of the issue in markdown format that will be shown in the UI and used when creating Jira Issues. HTML tags are not supported in the markdown format. For creating a new line `\n` can be used. Read more about the accepted markdown transformations [here](https://atlaskit.atlassian.com/packages/editor/editor-markdown-transformer).
+ *
+ * @example ## Overview
+ *
+ *
+ * Affected versions of this package are vulnerable to MeltLeak
+ */
+ description: string;
+ /**
+ * Format: uri
+ * @description A URL users can use to link to a summary view of this vulnerability, if appropriate.
+ *
+ * This could be any location that makes sense in the Provider system (e.g. if the summary information comes from a specific project, it might make sense to link the user to the vulnerability in that project).
+ *
+ * @example https://example.com/project/CWE-123/summary
+ */
+ url: string;
+ /**
+ * @description The type of Vulnerability detected.
+ * @example sca
+ * @enum {string}
+ */
+ type: "sca" | "sast" | "dast" | "unknown";
+ /**
+ * Format: date-time
+ * @description The timestamp to present to the user that shows when the Vulnerability was introduced.
+ *
+ * Expected format is an RFC3339 formatted string.
+ *
+ * @example 2018-01-20T23:27:25.000Z
+ */
+ introducedDate: string;
+ /**
+ * Format: date-time
+ * @description The last-updated timestamp to present to the user the last time the Vulnerability was updated.
+ *
+ * Expected format is an RFC3339 formatted string.
+ *
+ * @example 2018-01-20T23:27:25.000Z
+ */
+ lastUpdated: string;
+ /**
+ * VulnerabilitySeverity
+ * @description Severity information for a single Vulnerability.
+ *
+ * This is the severity information that will be presented to the user on e.g. the Jira Security screen.
+ */
+ severity: {
+ /**
+ * @description The severity level of the Vulnerability.
+ * @example critical
+ * @enum {string}
+ */
+ level: "critical" | "high" | "medium" | "low" | "unknown";
+ };
+ /** @description The identifying information for the Vulnerability. */
+ identifiers?: {
+ /**
+ * @description The display name of the Vulnerability identified.
+ *
+ * @example CWE-123
+ */
+ displayName: string;
+ /**
+ * Format: uri
+ * @description A URL users can use to link to the definition of the Vulnerability identified.
+ *
+ * @example https://cwe.mitre.org/data/definitions/123.html
+ */
+ url: string;
+ }[];
+ /**
+ * VulnerabilityStatus
+ * @description The current status of the Vulnerability.
+ *
+ * @example open
+ * @enum {string}
+ */
+ status: "open" | "closed" | "ignored" | "unknown";
+ /**
+ * VulnerabilityAdditionalInfo
+ * @description Extra information (optional). This data will be shown in the security feature under the vulnerability displayName.
+ */
+ additionalInfo?: {
+ /**
+ * @description The content of the additionalInfo.
+ *
+ * @example More information on the vulnerability, as a string
+ */
+ content: string;
+ /**
+ * Format: uri
+ * @description Optional URL linking to the information
+ *
+ * @example https://example.com/project/CWE-123/additionalInfo
+ */
+ url?: string;
+ };
+ /** @description The entities to associate the Security Vulnerability information with. */
+ associations?: {
+ /**
+ * @description Defines the association type.
+ *
+ * @example serviceIdOrKeys
+ * @enum {string}
+ */
+ associationType: "serviceIdOrKeys";
+ /**
+ * @description The service id or keys to associate the Security information with.
+ *
+ * The number of values counted across all associationTypes (serviceIdOrKeys) must not exceed a limit of 500.
+ */
+ values: string[];
+ }[];
+ };
+ };
+ };
+ /** @description Missing a JWT token, or token is invalid. */
+ 401: {
+ content: never;
+ };
+ /**
+ * @description The JWT token used does not correspond to an app that defines the `jiraSecurityInfoProvider` module,
+ * or the app does not define the 'READ' scope.
+ */
+ 403: {
+ content: never;
+ };
+ /** @description No data found for the given Vulnerability ID. */
+ 404: {
+ content: never;
+ };
+ /** @description API rate limit has been exceeded. */
+ 429: {
+ content: never;
+ };
+ /** @description Service is unavailable due to maintenance or other reasons. */
+ 503: {
+ content: never;
+ };
+ /** @description An unknown error has occurred. */
+ default: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ };
+ /**
+ * Delete a Vulnerability by ID
+ * @description Delete the Vulnerability data currently stored for the given ID.
+ *
+ * Deletion is performed asynchronously. The GET vulnerability endpoint can be used to confirm that data has been deleted successfully (if needed).
+ *
+ * Only Connect apps that define the `jiraSecurityInfoProvider` module can access this resource.
+ * This resource requires the 'DELETE' scope for Connect apps.
+ */
+ deleteVulnerabilityById: {
+ parameters: {
+ header: {
+ /**
+ * @description All requests must be signed with a Connect JWT token that corresponds to the Provider app installed in Jira.
+ *
+ * If the JWT token corresponds to an app that does not define Security Information module it will be rejected with a 403.
+ *
+ * Read more about JWT [here](https://developer.atlassian.com/blog/2015/01/understanding-jwt/).
+ */
+ Authorization: string;
+ };
+ path: {
+ /** @description The ID of the Vulnerability to delete. */
+ vulnerabilityId: string;
+ };
+ };
+ responses: {
+ /** @description Delete has been accepted. If the data exists, it will eventually be removed from Jira. */
+ 202: {
+ content: never;
+ };
+ /** @description Missing a JWT token, or token is invalid. */
+ 401: {
+ content: never;
+ };
+ /**
+ * @description The JWT token used does not correspond to an app that defines the `jiraSecurityInfoProvider` module,
+ * or the app does not define the 'DELETE' scope.
+ */
+ 403: {
+ content: never;
+ };
+ /** @description API rate limit has been exceeded. */
+ 429: {
+ content: never;
+ };
+ /** @description Service is unavailable due to maintenance or other reasons. */
+ 503: {
+ content: never;
+ };
+ /** @description An unknown error has occurred. */
+ default: {
+ content: {
+ "application/json": {
+ /** @description A human-readable message describing the error. */
+ message: string;
+ /** @description An optional trace ID that can be used by Jira developers to locate the source of the error. */
+ errorTraceId?: string;
+ }[];
+ };
+ };
+ };
+ };
+}
diff --git a/src/jira.test.ts b/src/jira.test.ts
new file mode 100644
index 0000000..e9954e8
--- /dev/null
+++ b/src/jira.test.ts
@@ -0,0 +1,289 @@
+import { expect, describe, it } from "vitest";
+import { JiraApi, JiraApiOptions } from "./jira";
+import axios, { Axios, AxiosError } from "axios";
+import MockAdapter from "axios-mock-adapter";
+
+function createTestInstance(actualOptions: Partial = {}) {
+ const finalOptions: JiraApiOptions = {
+ protocol: actualOptions.protocol || "http",
+ host: actualOptions.host || "jira.somehost.com",
+ port: "port" in actualOptions ? actualOptions.port : 8080,
+ username: actualOptions.username ?? "someusername",
+ password: actualOptions.password ?? "somepassword",
+ apiVersion: actualOptions.apiVersion || 2,
+ timeout: actualOptions.timeout || undefined,
+ base: actualOptions.base || "",
+ intermediatePath: actualOptions.intermediatePath,
+ bearer: actualOptions.bearer || null,
+ };
+ if ("axios" in actualOptions) {
+ finalOptions.axios = actualOptions.axios;
+ } else {
+ finalOptions.strictSSL = finalOptions.strictSSL ?? true;
+ finalOptions.ca = finalOptions.ca ?? undefined;
+ }
+
+ const jira = new JiraApi(finalOptions);
+ const mockAdapter = new MockAdapter(jira.axios);
+
+ return {
+ jira,
+ mockAdapter,
+ };
+}
+
+describe("Jira API Tests", () => {
+ describe("Constructor Tests", () => {
+ it("Constructor functions properly", () => {
+ const { jira } = createTestInstance();
+
+ expect(jira.protocol).to.eql("http");
+ expect(jira.host).to.eql("jira.somehost.com");
+ expect(jira.port).to.eql(8080);
+ expect(jira.baseOptions.auth.username).to.eql("someusername");
+ expect(jira.baseOptions.auth.password).to.eql("somepassword");
+ expect(jira.apiVersion).to.eql(2);
+ });
+
+ it("Constructor with no auth credentials", () => {
+ const { jira } = createTestInstance({
+ username: "",
+ password: "",
+ });
+
+ expect(jira.baseOptions.auth).to.be.undefined;
+ });
+
+ it("Constructor with bearer credentials", () => {
+ const { jira } = createTestInstance({
+ bearer: "testBearer",
+ });
+
+ expect(jira.baseOptions.headers.Authorization).to.eql("Bearer testBearer");
+ });
+
+ it("Constructor with timeout", () => {
+ const { jira } = createTestInstance({
+ timeout: 2,
+ });
+
+ expect(jira.baseOptions.timeout).to.equal(2);
+ });
+
+ it("Constructor with with ssl checking disabled", () => {
+ const { jira } = createTestInstance({
+ strictSSL: false,
+ });
+
+ expect(jira.httpsAgent).toBeDefined();
+ });
+
+ it("should allow the user to pass in a certificate authority", () => {
+ const { jira } = createTestInstance({
+ ca: "fakestring",
+ });
+
+ expect(jira.httpsAgent).toBeDefined();
+ });
+
+ it("should allow the user to pass in an axios instance", () => {
+ const { jira } = createTestInstance({
+ axios: axios.create(),
+ });
+
+ expect(jira.httpsAgent).toBeUndefined();
+ });
+ });
+
+ describe("makeRequestHeader Tests", () => {
+ it("makeRequestHeader functions properly in the average case", () => {
+ const { jira } = createTestInstance();
+
+ expect(
+ jira.makeRequestHeader(
+ jira.makeUri({
+ pathname: "/somePathName",
+ }),
+ ),
+ ).to.eql({
+ method: "GET",
+ url: "http://jira.somehost.com:8080/rest/api/2/somePathName",
+ });
+ });
+
+ it("makeRequestHeader functions properly with a different method", () => {
+ const { jira } = createTestInstance();
+
+ expect(
+ jira.makeRequestHeader(
+ jira.makeUri({
+ pathname: "/somePathName",
+ }),
+ { method: "POST" },
+ ),
+ ).toEqual({
+ method: "POST",
+ url: "http://jira.somehost.com:8080/rest/api/2/somePathName",
+ });
+ });
+ });
+
+ describe("makeUri", () => {
+ it("builds url with pathname and default host, protocol, port, and base api", () => {
+ const { jira } = createTestInstance();
+
+ expect(jira.makeUri({ pathname: "/somePathName" })).to.eql(
+ "http://jira.somehost.com:8080/rest/api/2/somePathName",
+ );
+ });
+
+ it("builds url with intermediatePath", () => {
+ const { jira } = createTestInstance();
+
+ expect(jira.makeUri({ pathname: "/somePathName", intermediatePath: "intermediatePath" })).to.eql(
+ "http://jira.somehost.com:8080/intermediatePath/somePathName",
+ );
+ });
+
+ it("builds url with globally specified intermediatePath", () => {
+ const { jira } = createTestInstance({
+ intermediatePath: "intermediatePath",
+ });
+
+ expect(jira.makeUri({ pathname: "/somePathName" })).to.eql(
+ "http://jira.somehost.com:8080/intermediatePath/somePathName",
+ );
+ });
+
+ it("builds url with query string parameters", () => {
+ const { jira } = createTestInstance();
+
+ const url = jira.makeUri({
+ pathname: "/path",
+ query: {
+ fields: "field1,field2",
+ expand: "three",
+ },
+ });
+
+ expect(url).toBe("http://jira.somehost.com:8080/rest/api/2/path?fields=field1%2Cfield2&expand=three");
+ });
+
+ it("makeWebhookUri functions properly in the average case", () => {
+ const { jira } = createTestInstance();
+
+ expect(
+ jira.makeWebhookUri({
+ pathname: "/somePathName",
+ }),
+ ).to.eql("http://jira.somehost.com:8080/rest/webhooks/1.0/somePathName");
+ });
+
+ it("makeUri functions properly no port http", () => {
+ const { jira } = createTestInstance({
+ port: undefined,
+ });
+
+ expect(
+ jira.makeUri({
+ pathname: "/somePathName",
+ }),
+ ).to.eql("http://jira.somehost.com/rest/api/2/somePathName");
+ });
+
+ it("makeUri functions properly no port https", () => {
+ const { jira } = createTestInstance({
+ protocol: "https",
+ port: undefined,
+ });
+
+ expect(
+ jira.makeUri({
+ pathname: "/somePathName",
+ }),
+ ).to.eql("https://jira.somehost.com/rest/api/2/somePathName");
+ });
+ });
+
+ describe("doRequest Tests", () => {
+ it("doRequest functions properly in the default case", async () => {
+ const { jira, mockAdapter } = createTestInstance();
+ mockAdapter.onGet("http://jira.somehost.com:8080/rest/api/2/somePathName").reply(200, "Successful response!");
+ mockAdapter.onGet().reply(200, "Nope");
+
+ const response = await jira.doRequest({
+ url: jira.makeUri({ pathname: "/somePathName" }),
+ });
+
+ expect(response).toEqual("Successful response!");
+ });
+
+ it("doRequest authenticates properly when specified", async () => {
+ const username = "someusername";
+ const password = "somepassword";
+
+ const { jira, mockAdapter } = createTestInstance({
+ username,
+ password,
+ });
+ mockAdapter
+ .onGet("http://jira.somehost.com:8080/rest/api/2/somePathName", {
+ headers: {
+ Authorization: "Basic c29tZXVzZXJuYW1lOnNvbWVwYXNzd29yZA==",
+ },
+ })
+ .reply(200, "Successful response!");
+
+ const result = await jira.doRequest({
+ url: jira.makeUri({ pathname: "/somePathName" }),
+ });
+ expect(result).toBe("Successful response!");
+ });
+
+ it("doRequest times out with specified option", async () => {
+ const { jira, mockAdapter } = createTestInstance({
+ timeout: 1,
+ });
+ mockAdapter.onGet().timeout();
+
+ try {
+ const result = await jira.doRequest({});
+ } catch (e) {
+ expect(e.message).toBe("timeout of 1ms exceeded");
+ }
+ });
+
+ it("doRequest throws an error properly", async () => {
+ const { jira, mockAdapter } = createTestInstance();
+
+ expect(jira.doRequest({})).rejects.toThrowError("Request failed with status code 404");
+ });
+
+ it("doRequest throws a list of errors properly", async () => {
+ const { jira, mockAdapter } = createTestInstance();
+ mockAdapter.onGet().reply(400, { errorMessages: ["some error to throw"] });
+
+ try {
+ await jira.doRequest({});
+ } catch (error) {
+ expect(axios.isAxiosError(error)).toBe(true);
+ expect(error.response?.status).toBe(400);
+ }
+ });
+
+ it("doRequest does not throw an error on empty response", async () => {
+ const { jira, mockAdapter } = createTestInstance();
+ mockAdapter.onGet().reply(200, undefined);
+
+ const response = await jira.doRequest({});
+ expect(response).to.be.undefined;
+ });
+
+ it("doRequest throws an error when request failed", async () => {
+ const { jira, mockAdapter } = createTestInstance();
+ mockAdapter.onGet().reply(404, "This is an error message");
+
+ expect(jira.doRequest({})).rejects.toThrowError("Request failed with status code 404");
+ });
+ });
+});
diff --git a/src/jira.ts b/src/jira.ts
index b90e5d4..a5b609d 100644
--- a/src/jira.ts
+++ b/src/jira.ts
@@ -1,1454 +1,1147 @@
-import * as url from 'url'
-import axios, { AxiosInstance, AxiosRequestConfig, Method } from 'axios'
-
-interface MakeUrlParams {
- pathname?: string
- query?: Record
- intermediatePath?: string
- encode?: boolean
-}
-
-interface MakeSprintUrlParams {
- pathname?: string
- query?: Record
- intermediatePath?: string
-}
-
-export interface JiraApiOptions {
- protocol: 'http' | 'https'
- host: string
- port?: number
- apiVersion?: 1 | 2
- base?: string
- intermediatePath?: string
- webHookVersion?: string
- greenhopperVersion?: string
- baseOptions?: AxiosRequestConfig
- axios?: AxiosInstance
- strictSSL?: boolean
- oauth?: {
- consumer_key: string
- access_token: string
- consumer_secret: string
- access_token_secret: string
- signature_method: string
- }
- bearer?: string
- timeout?: number
- username?: string
- password?: string
+import axios, { Axios, AxiosInstance, AxiosRequestConfig } from "axios";
+import { Agent } from "https";
+import { components, operations as cloudOperations } from "./generated/openapi-cloud";
+import { operations } from "./generated/openapi-software";
+
+export interface MakeUrlParams {
+ pathname?: string;
+ query?: Record;
+ intermediatePath?: string;
+ encode?: boolean;
}
+export type WithStrictSSL = {
+ strictSSL?: boolean;
+ ca?: string;
+ axios?: undefined;
+};
+
+export type WithAxios = {
+ axios?: AxiosInstance;
+ strictSSL?: undefined;
+ ca?: undefined;
+};
+
+export type AxiosOrStrict = WithStrictSSL | WithAxios;
+
+export type JiraApiOptions = {
+ protocol?: "http" | "https";
+ host: string;
+ port?: number;
+ apiVersion?: 1 | 2 | 3;
+ base?: string;
+ intermediatePath?: string;
+ webHookVersion?: string;
+ baseOptions?: AxiosRequestConfig;
+ bearer?: string;
+ timeout?: number;
+ username?: string;
+ password?: string;
+} & AxiosOrStrict;
+
+export type PaginationParams = {
+ startAt?: number;
+ maxResults?: number;
+ fields?: string[];
+ expand?: string[];
+};
/**
- * @name JiraApi
- * @class
* Wrapper for the JIRA Rest Api
* https://docs.atlassian.com/jira/REST/6.4.8/
*/
-export default class JiraApi {
- protocol: string
-
- host: string
-
- port: number
-
- apiVersion: number
-
- base: string
-
- intermediatePath: string
-
- strictSSL: any
-
- axios: AxiosInstance
-
- webhookVersion: string
-
- greenhopperVersion: string
-
- baseOptions: AxiosRequestConfig
+export class JiraApi {
+ protocol: string;
+ host: string;
+ port: number;
+ apiVersion: number;
+ base: string;
+ intermediatePath: string;
+ axios: AxiosInstance;
+ httpsAgent?: Agent;
+ webhookVersion: string;
+ baseOptions: AxiosRequestConfig;
/**
+ * Construct a new JiraApi
* @constructor
- * @function
* @param {JiraApiOptions} options
*/
constructor(options: JiraApiOptions) {
- this.protocol = options.protocol || 'http'
- this.host = options.host
- this.port = options.port || null
- this.apiVersion = options.apiVersion || 2
- this.base = options.base || ''
- this.intermediatePath = options.intermediatePath
+ this.protocol = options.protocol || "https";
+ this.host = options.host;
+ this.port = options.port || null;
+ this.apiVersion = options.apiVersion || 2;
+ this.base = options.base || "";
+ this.intermediatePath = options.intermediatePath;
+
// This is so we can fake during unit tests
- this.axios = options.axios || axios.create()
- this.webhookVersion = options.webHookVersion || '1.0'
- this.greenhopperVersion = options.greenhopperVersion || '1.0'
- this.baseOptions = { ...options.baseOptions }
+ if ("axios" in options) {
+ this.axios = options.axios;
+ } else if ("strictSSL" in options || "ca" in options) {
+ this.httpsAgent = new Agent({ rejectUnauthorized: !options.strictSSL, ca: options.ca });
+ this.axios = axios.create({
+ httpsAgent: this.httpsAgent,
+ });
+ } else {
+ this.axios = axios.create();
+ }
+ this.webhookVersion = options.webHookVersion || "1.0";
+ this.baseOptions = { ...options.baseOptions };
- if (!this.baseOptions.headers) this.baseOptions.headers = {}
+ if (!this.baseOptions.headers) this.baseOptions.headers = {};
if (options.bearer) {
- this.baseOptions.headers['Authorization'] = 'Bearer ' + options.bearer
+ this.baseOptions.headers.Authorization = `Bearer ${options.bearer}`;
} else if (options.username && options.password) {
this.baseOptions.auth = {
username: options.username,
password: options.password,
- }
+ };
}
if (options.timeout) {
- this.baseOptions.timeout = options.timeout
+ this.baseOptions.timeout = options.timeout;
}
- this.baseOptions.headers['X-Atlassian-Token'] = 'no-check'
+ this.baseOptions.headers["X-Atlassian-Token"] = "no-check";
}
/**
- * @typedef JiraApiOptions
- * @type {object}
- * @property {string} [protocol=http] - What protocol to use to connect to
- * jira? Ex: http|https
- * @property {string} host - What host is this tool connecting to for the jira
- * instance? Ex: jira.somehost.com
- * @property {string} [port] - What port is this tool connecting to jira with? Only needed for
- * none standard ports. Ex: 8080, 3000, etc
- * @property {string} [username] - Specify a username for this tool to authenticate all
- * requests with.
- * @property {string} [password] - Specify a password for this tool to authenticate all
- * requests with. Cloud users need to generate an [API token](https://confluence.atlassian.com/cloud/api-tokens-938839638.html) for this value.
- * @property {string} [apiVersion=2] - What version of the jira rest api is the instance the
- * tool is connecting to?
- * @property {string} [base] - What other url parts exist, if any, before the rest/api/
- * section?
- * @property {string} [intermediatePath] - If specified, overwrites the default rest/api/version
- * section of the uri
- * @property {boolean} [strictSSL=true] - Does this tool require each request to be
- * authenticated? Defaults to true.
- * @property {function} [request] - What method does this tool use to make its requests?
- * Defaults to request from request-promise
- * @property {number} [timeout] - Integer containing the number of milliseconds to wait for a
- * server to send response headers (and start the response body) before aborting the request. Note
- * that if the underlying TCP connection cannot be established, the OS-wide TCP connection timeout
- * will overrule the timeout option ([the default in Linux can be anywhere from 20-120 *
- * seconds](http://www.sekuda.com/overriding_the_default_linux_kernel_20_second_tcp_socket_connect_timeout)).
- * @property {string} [webhookVersion=1.0] - What webhook version does this api wrapper need to
- * hit?
- * @property {string} [greenhopperVersion=1.0] - What webhook version does this api wrapper need
- * to hit?
- * @property {string} [ca] - Specify a CA certificate
- * @property {OAuth} [oauth] - Specify an OAuth object for this tool to authenticate all requests
- * using OAuth.
- * @property {string} [bearer] - Specify an OAuth bearer token to authenticate all requests with.
- */
-
- /**
- * @typedef OAuth
- * @type {object}
- * @property {string} consumer_key - The consumer entered in Jira Preferences.
- * @property {string} consumer_secret - The private RSA file.
- * @property {string} access_token - The generated access token.
- * @property {string} access_token_secret - The generated access toke secret.
- * @property {string} signature_method [signature_method=RSA-SHA1] - OAuth signurate methode
- * Possible values RSA-SHA1, HMAC-SHA1, PLAINTEXT. Jira Cloud supports only RSA-SHA1.
- */
-
- /**
- * @typedef {object} UriOptions
- * @property {string} pathname - The url after the specific functions path
- * @property {object} [query] - An object of all query parameters
- * @property {string} [intermediatePath] - Overwrites with specified path
- */
-
- /**
- * @name makeRequestHeader
- * @function
* Creates a requestOptions object based on the default template for one
- * @param {string} uri
- * @param {object} [options] - an object containing fields and formatting how the
+ * @param url
+ * @param options an object containing fields and formatting how the
*/
- makeRequestHeader(url, options: AxiosRequestConfig = {}): AxiosRequestConfig {
+ makeRequestHeader(url: string, options: AxiosRequestConfig = {}): AxiosRequestConfig {
return {
- method: options.method || 'GET',
+ method: options.method || "GET",
url,
...options,
- }
+ };
}
/**
- * @typedef makeRequestHeaderOptions
- * @type {object}
- * @property {string} [method] - HTTP Request Method. ie GET, POST, PUT, DELETE
- */
-
- /**
- * @name makeUri
- * @function
* Creates a URI object for a given pathname
- * @param {object} [options] - an object containing path information
- */
- makeUri({
- pathname,
- query,
- intermediatePath,
- encode = false,
- }: MakeUrlParams) {
- const intermediateToUse = this.intermediatePath || intermediatePath
- const tempPath = intermediateToUse || `/rest/api/${this.apiVersion}`
- const uri = url.format({
- protocol: this.protocol,
- hostname: this.host,
- port: this.port,
- pathname: `${this.base}${tempPath}${pathname}`,
- query,
- })
- return encode ? encodeURI(uri) : decodeURIComponent(uri)
+ * @param [options] - an object containing path information
+ */
+ makeUri({ pathname, query, intermediatePath }: MakeUrlParams) {
+ const intermediateToUse = this.intermediatePath || intermediatePath;
+ const tempPath = intermediateToUse || `/rest/api/${this.apiVersion}`;
+ const uri = new URL("http://localhost");
+ uri.protocol = this.protocol;
+ uri.hostname = this.host;
+ uri.port = this.port?.toString();
+ uri.pathname = `${this.base}${tempPath}${pathname}`;
+
+ for (const key in query) {
+ uri.searchParams.append(key, query[key].toString());
+ }
+ return uri.toString();
}
/**
- * @typedef makeUriOptions
- * @type {object}
- * @property {string} pathname - The url after the /rest/api/version
- * @property {object} query - a query object
- * @property {string} intermediatePath - If specified will overwrite the /rest/api/version section
- */
-
- /**
- * @name makeWebhookUri
- * @function
* Creates a URI object for a given pathName
- * @param {object} [options] - An options object specifying uri information
+ * @param [options] - An options object specifying uri information
*/
makeWebhookUri({
pathname,
- intermediatePath,
}: {
- pathname?: string
- intermediatePath?: string
+ pathname?: string;
}) {
- const intermediateToUse = this.intermediatePath || intermediatePath
- const tempPath =
- intermediateToUse || `/rest/webhooks/${this.webhookVersion}`
- const uri = url.format({
- protocol: this.protocol,
- hostname: this.host,
- port: this.port,
- pathname: `${this.base}${tempPath}${pathname}`,
- })
- return decodeURIComponent(uri)
- }
-
- /**
- * @typedef makeWebhookUriOptions
- * @type {object}
- * @property {string} pathname - The url after the /rest/webhooks
- * @property {string} intermediatePath - If specified will overwrite the /rest/webhooks section
- */
-
- /**
- * @name makeSprintQueryUri
- * @function
- * Creates a URI object for a given pathName
- * @param {object} [options] - The url after the /rest/
- */
- makeSprintQueryUri({
- pathname,
- query,
- intermediatePath,
- }: MakeSprintUrlParams) {
- const intermediateToUse = this.intermediatePath || intermediatePath
- const tempPath =
- intermediateToUse || `/rest/greenhopper/${this.greenhopperVersion}`
- const uri = url.format({
- protocol: this.protocol,
- hostname: this.host,
- port: this.port,
- pathname: `${this.base}${tempPath}${pathname}`,
- query,
- })
- return decodeURIComponent(uri)
+ return this.makeUri({
+ pathname,
+ intermediatePath: `/rest/webhooks/${this.webhookVersion}`,
+ });
}
/**
- * @typedef makeSprintQueryUriOptions
- * @type {object}
- * @property {string} pathname - The url after the /rest/api/version
- * @property {object} query - a query object
- * @property {string} intermediatePath - will overwrite the /rest/greenhopper/version section
- */
-
- /**
- * @typedef makeDevStatusUri
- * @function
* Creates a URI object for a given pathname
- * @arg {pathname, query, intermediatePath} obj1
- * @param {string} pathname obj1.pathname - The url after the /rest/api/version
- * @param {object} query obj1.query - a query object
- * @param {string} intermediatePath obj1.intermediatePath - If specified will overwrite the
* /rest/dev-status/latest/issue/detail section
*/
makeDevStatusUri({
pathname,
query,
- intermediatePath,
}: {
- pathname?: string
- query?: Record