https://github.com/jjlongoria/jira-server-cli
CLI application to manage and work with Atlassian Jira. Work with your Jira projects and issues (amonth to many other options) from Command lines.
https://github.com/jjlongoria/jira-server-cli
atlassian atlassian-jira cli jira jira-cli jira-rest-api jira-server jira-server-cli oclif
Last synced: 3 months ago
JSON representation
CLI application to manage and work with Atlassian Jira. Work with your Jira projects and issues (amonth to many other options) from Command lines.
- Host: GitHub
- URL: https://github.com/jjlongoria/jira-server-cli
- Owner: JJLongoria
- License: gpl-3.0
- Created: 2022-09-09T23:46:17.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-09-12T23:45:36.000Z (almost 3 years ago)
- Last Synced: 2024-11-25T03:29:34.295Z (7 months ago)
- Topics: atlassian, atlassian-jira, cli, jira, jira-cli, jira-rest-api, jira-server, jira-server-cli, oclif
- Language: TypeScript
- Homepage:
- Size: 288 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[**Jira Server CLI Application - BETA -**]()
=================
[](https://www.npmjs.com/package/jira-server-cli)
[](https://www.npmjs.com/package/jira-server-cli/core)
[](https://www.npmjs.com/package/jira-server-cli)
[](https://github.com/JJLongoria/jira-server-cli/issues)
[](https://snyk.io/test/github/JJLongoria/jira-server-cli)
[](https://github.com/JJLongoria/jira-server-cli)
[](https://github.com/JJLongoria/jira-server-cli/blob/master/LICENSE)
**CLI application** to manage and work with **Atlassian Jira Server**. The benefits of a CLI applications are both, able to the users to **handle Jira Issues outside Jira**, and more important, can **automate** Tasks against Jira like autoresolve issues for example. This tool are designed to be really easy to learn and use because group topics and commands with a semantic names.
**Jira Server CLI** allow to any user to work with **Jira outside Jira** from a command line. Admin Jira with the Administration commands or updated your user details easy from the command line. You can Create or Update issues with a simple command. Add comments to a issue. Grant or Revoke permissions in a few steps and every what you want with Jira.
**Automate** every task from the command line easy to make many things automatically. There are many posibilities.
To learn more or read a full documentation of the **Jira Server CLI Application**, go to the [**Official Documentation Site**](https://github.com/JJLongoria/jira-server-cli/wiki).
This CLI Application use the [**Jira Server Connector**](https://github.com/JJLongoria/jira-server-connector) library to connect and work with Jira.
Supported Operative Systems:
- Windows
- Linux
- Mac OS X
Now Stil in BETA Version because is not fully tested and continue in development.
---
- [**Jira Server CLI Application - BETA -**](#jira-server-cli-application---beta--)
- [**Installation Guide**](#installation-guide)
- [**NPM**](#npm)
- [**Windows Standalone**](#windows-standalone)
- [**Usage**](#usage)
- [**CLI Responses**](#cli-responses)
- [**JiraCLIResponse**](#jiracliresponset)
- [**JiraCLIError**](#jiraclierror)
- [**JiraCLIErrorData**](#jiraclierrordata)
- [**Paginated API**](#paginated-api)
- [**Pagination Flags**](#pagination-flags)
- [**CLI Output Format**](#cli-output-format)
- [**Table**](#table)
- [**JSON**](#json)
- [**CSV**](#csv)
- [**Core CLI Commands**](#core-cli-commands)
- [**`jiraserver help [COMMAND]`**](#jiraserver-help-command)
- [**`jiraserver update`**](#jiraserver-update)
- [**`jiraserver commands`**](#jiraserver-commands)
- [**`jiraserver plugins`**](#jiraserver-plugins)
- [**`jiraserver plugins:install PLUGIN...`**](#jiraserver-pluginsinstall-plugin)
- [**`jiraserver plugins:inspect PLUGIN...`**](#jiraserver-pluginsinspect-plugin)
- [**`jiraserver plugins:link PLUGIN`**](#jiraserver-pluginslink-plugin)
- [**`jiraserver plugins:uninstall PLUGIN...`**](#jiraserver-pluginsuninstall-plugin)
- [**Main CLI Topics**](#main-cli-topics)
- [**JSON Objects Schemes**](#json-objects-schemes)
- [**Application**](#application)
- [**ApplicationProperty**](#applicationproperty)
- [**ApplicationRole**](#applicationrole)
- [**ApplicationRoleInput**](#applicationroleinput)
- [**Attachment**](#attachment)
- [**Avatar**](#avatar)
- [**AttachmentMeta**](#attachmentmeta)
- [**ChangeHistory**](#changehistory)
- [**ChangeItem**](#changeitem)
- [**ChangeLog**](#changelog)
- [**ColumnItem**](#columnitem)
- [**Comment**](#comment)
- [**CommentInput**](#commentinput)
- [**Component**](#component)
- [**ComponentInput**](#componentinput)
- [**ComponentIssuesCount**](#componentissuescount)
- [**Configuration**](#configuration)
- [**ConfigurationTimeTracking**](#configurationtimetracking)
- [**CreateMeta**](#createmeta)
- [**CustomField**](#customfield)
- [**CustomFieldDefinition**](#customfielddefinition)
- [**CustomFieldOption**](#customfieldoption)
- [**Dashboard**](#dashboard)
- [**DeletedFieldsOutput**](#deletedfieldsoutput)
- [**EditMeta**](#editmeta)
- [**EntityProperty**](#entityproperty)
- [**EntityPropertyKey**](#entitypropertykey)
- [**EntityPropertyKeys**](#entitypropertykeys)
- [**Field**](#field)
- [**FieldSchema**](#fieldschema)
- [**Filter**](#filter)
- [**FilterInput**](#filterinput)
- [**FieldMeta**](#fieldmeta)
- [**FilterPermission**](#filterpermission)
- [**FilterPermissionInput**](#filterpermissioninput)
- [**FilterSubscription**](#filtersubscription)
- [**FilterSubscriptionInput**](#filtersubscriptioninput)
- [**Group**](#group)
- [**GroupSuggestions**](#groupsuggestions)
- [**GroupSuggestion**](#groupsuggestion)
- [**GroupSuggestionLabel**](#groupsuggestionlabel)
- [**HistoryMetadata**](#historymetadata)
- [**Icon**](#icon)
- [**Instance**](#instance)
- [**Issue**](#issue)
- [**IssueInput**](#issueinput)
- [**IssueLink**](#issuelink)
- [**IssueLinks**](#issuelinks)
- [**IssueLinkType**](#issuelinktype)
- [**IssueLinkTypes**](#issuelinktypes)
- [**IssuePicker**](#issuepicker)
- [**IssuePickerOutput**](#issuepickeroutput)
- [**IssuePickerSection**](#issuepickersection)
- [**IssueNotification**](#issuenotification)
- [**IssueNotificationTo**](#issuenotificationto)
- [**IssueNotificationPermission**](#issuenotificationpermission)
- [**IssueNotificationRetrict**](#issuenotificationretrict)
- [**IssueReference**](#issuereference)
- [**IssueReferenceFields**](#issuereferencefields)
- [**IssueRemoteLink**](#issueremotelink)
- [**IssueSecuritySchemes**](#issuesecurityschemes)
- [**IssueTransition**](#issuetransition)
- [**IssueTransitions**](#issuetransitions)
- [**IssueTransitionInput**](#issuetransitioninput)
- [**IssueType**](#issuetype)
- [**IssueTypeScheme**](#issuetypescheme)
- [**IssueTypeSchemeList**](#issuetypeschemelist)
- [**IssueVotes**](#issuevotes)
- [**IssueWatchers**](#issuewatchers)
- [**JsonType**](#jsontype)
- [**LinkGroup**](#linkgroup)
- [**LinkIssue**](#linkissue)
- [**LinkIssueRequest**](#linkissuerequest)
- [**ListWrapper**](#listwrapper)
- [**Participant**](#participant)
- [**Permission**](#permission)
- [**PermissionGrant**](#permissiongrant)
- [**PermissionHolder**](#permissionholder)
- [**PermissionsOutput**](#permissionsoutput)
- [**PermissionScheme**](#permissionscheme)
- [**PermissionSchemes**](#permissionschemes)
- [**Priority**](#priority)
- [**Project**](#project)
- [**ProjectCategory**](#projectcategory)
- [**ProjectRole**](#projectrole)
- [**RemoteEntityLink**](#remoteentitylink)
- [**RemoteObject**](#remoteobject)
- [**RemoteObjectStatus**](#remoteobjectstatus)
- [**RoleActor**](#roleactor)
- [**SecurityScheme**](#securityscheme)
- [**SecuritySchemeLevel**](#securityschemelevel)
- [**ShareScope**](#sharescope)
- [**SimpleLink**](#simplelink)
- [**Status**](#status)
- [**StatusCategory**](#statuscategory)
- [**SystemAvatars**](#systemavatars)
- [**User**](#user)
- [**UserPermission**](#userpermission)
- [**UserPermissionsOutput**](#userpermissionsoutput)
- [**Version**](#version)
- [**Visibility**](#visibility)
- [**IssueWorklog**](#issueworklog)
- [**IssueWorklogInput**](#issueworkloginput)
# [**Installation Guide**]()
## [**NPM**]()
Installation with NPM manager is, at the moment, the unique way to install Jira Server CLI on Linux and MacOs systems.
Install Node JS on your computer:
To install NodeJS on Windows systems go to [Node JS Webpage](https://nodejs.org/) and download the latest version for Windows.
To install NodeJS on Linux systems go to ["Installing Node.js via package manager"](https://nodejs.org/en/download/package-manager/) and choose the correct option according your linux system.
With NodeJS installed on your system, now open a terminal (CMD, Bash, Power Shell...) and run the next command:
npm install -g jira-server-cli
## [**Windows Standalone**]()
If you don't want to install NPM on your windows system to install Jira Server CLI, can download the installer and install it without node on windows systemas.
- [**Windows x64**](https://github.com/JJLongoria/jira-server-cli/raw/main/installers/jira-server-cli_win_x64.exe)
# [**Usage**]()
```sh-session
$ jiraserver COMMAND [args] [flags]
running command...
$ jiraserver --help [COMMAND]
...
```
# [**CLI Responses**]()
All commands **except Core CLI Commands** return the same response JSON Object for a better reponse handling and standarization. The JSON response definition is the next:
## [**JiraCLIResponse**]()
```js
{
status: 0 | -1 = 0; // Returned status. 0 OK, -1 KO
message?: string; // General execution status message
result?: T; // Response data when status is 0. (Not all Ok responses return data)
error?: JiraCLIError; // Error data when status is -1.
}
```
The **`JiraCLIResponse`** `result` property has **Generic type** (`T`), that means the result can be of any type defined in [**JSON Objects Schemes**](#json-objects-schemes) or primitive types likes `string` or `string[]` among others.
## [**JiraCLIError**]()
The **`JiraCLIResponse`** object contains the `JiraCLIError` on `error` property to return the errors data. This object has the next definition:
```js
{
statusCode?: number; // The status code of execution
status?: string; // The error status
statusText?: string; // The error status text
errors?: JiraCLIErrorData[]; // Error details
}
```
## [**JiraCLIErrorData**]()
The error object **`JiraCLIError`** has a collection of errors with detailed error data, the JSON object is the next:
```js
{
errorMessages: string[], // Error messages list
errors: { [key: string]: string }, // Error messages map
status: number, // Error status
}
```
# [**Paginated API**]()
The **Jira API Rest** work with **paginated results**, this means that the most of list commands return a **`Page`** whith a collection of values of the requested data types. For example, when retrieve projects, get a **`Page`** with the paginated values.
The **`Page`** object has the page data, size, limit and next page start among other data to use the paginated API.
```ts
class Page {
startAt: number; // The first record page
maxResults: number; // Max page results
total: number; // Total results
isLast: boolean; // true if is the last page
values: T[]; // Collection values
self?: string; // Self link
nextPage?: string; // Next page link
previousPage?: string; // Previous page link
nextPageStart?: number; // First record of the next page
}
```
**IMPORTANT**: The response contains a "total" field which denotes the total number of entities contained in all pages. This number may change as the client requests the subsequent pages. A client should always assume that the requested page can be empty. REST API consumers should also consider the field to be optional. In cases, when calculating this value is too expensive we may not include this in response.
## [**Pagination Flags**]()
All commands that support paginations (the most of list commands) has the same flags to support and user the paginated api, this flags are listed below:
| Name | flag | Type | Description |
| ---------- | ---------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **All** | `--all` | [`Boolean`]() | Return all records on the same page (instead paginate results) |
| **Limit** | `--limit` | [`Integer`]() | Indicates how many results to return per page |
| **Start** | `--start` | [`Integer`]() | Indicates which item should be used as the first item in the page of results |
| **order** | `--start` | [`string`]() | Some resources support ordering by a specific field. Ordering can be ascending or descending. To specify the ordering use "-" or "+" sign. Examples: --order "+name"; --order "name"; --order "-name" |
| **expand** | `--expand` | [`string`]() | Some resources support support to expand the returned informacion |
# [**CLI Output Format**]()
The Jira Server CLI support to return the output in different formats, CSV, JSON and Table. All commands support the JSON Output. All commands that return data into the `result` property support Table and CSV outputs. All commands that support tables, support also CSV output.
## [**Table**]()
Is the standard output if not select any other type, this is the best human readable response. All commands that support CSV output, support tables output too. To many commands has the `--extended` flag. This flag is for show more columns on the tables (By default, not show all columns in many commands).
## [**JSON**]()
Is the most complete response and the best to work with the command, but is not human readable like a table. The flag to return a JSON output is `--json`
## [**CSV**]()
To many commands support to format the output as JSON (the same with output as table). This response contains the same information of an extended table but in different format. The flag to format as csv is `--csv`.
# [**Core CLI Commands**]()
## **`jiraserver help [COMMAND]`**
Display help for Jira Server CLI.
```
USAGE
$ jiraserver help [COMMAND] [-n]
ARGUMENTS
COMMAND Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for Jira Server CLI.
```
## **`jiraserver update`**
Update the Jira Server CLI.
```
USAGE
$ jiraserver update [CHANNEL] [-a] [-v | -i] [--force]
FLAGS
-a, --available Install a specific version.
-i, --interactive Interactively select version to install. This is ignored if a channel is provided.
-v, --version= Install a specific version.
--force Force a re-download of the requested version.
DESCRIPTION
Update the Jira Server CLI
EXAMPLES
Update to the stable channel:
$ jiraserver update stable
Update to a specific version:
$ jiraserver update --version 1.0.0
Interactively select version:
$ jiraserver update --interactive
See available versions:
$ jiraserver update --available
```
## **`jiraserver commands`**
List all the commands
```
USAGE
$ jiraserver commands [--json] [-h] [--hidden] [--tree] [--columns | -x] [--sort ] [--filter ] [--output csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
FLAGS
-h, --help Show CLI help.
-x, --extended show extra columns
--columns= only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter= filter property by partial string matching, ex: name=foo
--hidden show hidden commands
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output= output in a more machine friendly format
--sort= property to sort by (prepend '-' for descending)
--tree show tree of commands
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List all the commands
```
## **`jiraserver plugins`**
List installed plugins.
```
USAGE
$ jiraserver plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ jiraserver plugins
```
## **`jiraserver plugins:install PLUGIN...`**
Installs a plugin into the CLI.
```
USAGE
$ jiraserver plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a "hello" command, installing a user-installed plugin with a "hello" command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ jiraserver plugins add
EXAMPLES
$ jiraserver plugins:install myplugin
$ jiraserver plugins:install https://github.com/someuser/someplugin
$ jiraserver plugins:install someuser/someplugin
```
## **`jiraserver plugins:inspect PLUGIN...`**
Displays installation properties of a plugin.
```
USAGE
$ jiraserver plugins:inspect PLUGIN...
ARGUMENTS
PLUGIN [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ jiraserver plugins:inspect myplugin
```
## **`jiraserver plugins:link PLUGIN`**
Links a plugin into the CLI for development.
```
USAGE
$ jiraserver plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Links a plugin into the CLI for development.
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a "hello" command, installing a linked plugin with a "hello"
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLES
$ jiraserver plugins:link myplugin
```
## **`jiraserver plugins:uninstall PLUGIN...`**
Removes a plugin from the CLI.
```
USAGE
$ jiraserver plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ jiraserver plugins unlink
$ jiraserver plugins remove
```
Removes a plugin from the CLI.
```
USAGE
$ jiraserver plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ jiraserver plugins unlink
$ jiraserver plugins remove
```
# [**Main CLI Topics**]()
The [**Jira Server CLI Application**]() has to many commands to handle to many Jira Server features. All commands are grouped in **topics**, any many topics has **subtopics** to better organization of commands (and better to learn and understand).
The main topics are listed below.
# [**JSON Objects Schemes**]()
All JSON Schemes used by the Jira Server CLI application as response or data input are listed bellow.
**Schema definition**:
```json
{
"FieldName": "FieldType", // Required field
"FieldName?": "FieldType", // Optional field
}
```
---
---
## [**Application**]()
```json
{
"type": "string",
"name": "string",
}
```
---
## [**ApplicationProperty**]()
```json
{
"id": "string",
"key": "string",
"value": "string",
"name": "string",
"desc": "string",
"type": "string",
"defaultValue": "string",
"example?": "string",
"allowedValues?": "string[]",
}
```
---
## [**ApplicationRole**]()
```json
{
"key": "string",
"groups": "string[]",
"name": "string",
"defaultGroups": "string[]",
"selectedByDefault": "boolean",
"defined": "boolean",
"numberOfSeats": "number",
"remainingSeats": "number",
"userCount": "number",
"userCountDescription": "string",
"hasUnlimitedSeats": "boolean",
"platform": "boolean",
}
```
---
## [**ApplicationRoleInput**]()
```json
{
"key": "string",
"group?s": "string[]",
"defaultGroups?": "string[]",
}
```
---
## [**Attachment**]()
```json
{
"id": "string",
"filename": "string",
"author": "User",
"created": "string",
"size": "number",
"mimeType": "string",
"properties": "any",
"content": "string",
"thumbnail": "string",
}
```
- See [**User**](#user) Definition.
## [**Avatar**]()
```json
{
"id": "string",
"owner": "string",
"isSystemAvatar": "boolean",
"isSelected": "boolean",
"isDeletable": "boolean",
"urls": "{ [key: string]: string }",
"selected": "boolean",
}
```
---
## [**AttachmentMeta**]()
```json
{
"enabled": "boolean",
"uploadLimit?": "number",
}
```
---
## [**ChangeHistory**]()
```json
{
"id": "string",
"author": "User",
"created": "string",
"items": "ChangeItem[]",
"historyMetadata": "HistoryMetadata",
}
```
- See [**ChangeItem**](#changeitem) Definition.
- See [**HistoryMetadata**](#historymetadata) Definition.
---
## [**ChangeItem**]()
```json
{
"field": "string",
"fieldtype": "string",
"from": "string",
"fromString": "string",
"to": "string",
"toString": "string",
}
```
---
## [**ChangeLog**]()
```json
{
"startAt": "number",
"maxResults": "number",
"total": "number",
"histories": "ChangeHistory[]",
}
```
- See [**ChangeHistory**](#changehistory) Definition.
---
## [**ColumnItem**]()
```json
{
"label": "string",
"value": "string",
}
```
---
## [**Comment**]()
```json
{
"id": "string",
"author": "User",
"body": "string",
"renderedBody": "string",
"updateAuthor": "User",
"created": "string",
"updated": "string",
"visibility": "Visibility",
"properties": "EntityProperty[]",
}
```
- See [**User**](#user) Definition.
- See [**Visibility**](#visibility) Definition.
- See [**EntityProperty**](#entityproperty) Definition.
---
## [**CommentInput**]()
```json
{
"body": "string",
"visibility": "Visibility",
}
```
- See [**Visibility**](#visibility) Definition.
---
## [**Component**]()
```json
{
"id?": "string",
"name": "string",
"description": "string",
"lead?": "User",
"leadUserName": "string",
"assigneeType": "'PROJECT_DEFAULT' | 'COMPONENT_LEAD' | 'PROJECT_LEAD' | 'UNASSIGNED'",
"assignee?": "User",
"realAssigneeType?": "'PROJECT_DEFAULT' | 'COMPONENT_LEAD' | 'PROJECT_LEAD' | 'UNASSIGNED'",
"realAssignee?": "User",
"isAssigneeTypeValid": "boolean",
"project": "string",
"projectId": "number",
"archived?": "boolean",
"deleted?": "boolean",
}
```
- See [**User**](#user) Definition.
---
## [**ComponentInput**]()
```json
{
"name": "string",
"description": "string",
"leadUserName": "string",
"assigneeType": "'PROJECT_DEFAULT' | 'COMPONENT_LEAD' | 'PROJECT_LEAD' | 'UNASSIGNED'",
"isAssigneeTypeValid": "boolean",
"project": "string",
"projectId": "number",
}
```
- See [**User**](#user) Definition.
## [**ComponentIssuesCount**]()
```json
{
"issueCount": "number",
"self?": "string",
}
```
---
## [**Configuration**]()
```json
{
"votingEnabled": "boolean",
"watchingEnabled": "boolean",
"unassignedIssuesAllowed": "boolean",
"subTasksEnabled": "boolean",
"issueLinkingEnabled": "boolean",
"timeTrackingEnabled": "boolean",
"attachmentsEnabled": "boolean",
"timeTrackingConfiguration?": "ConfigurationTimeTracking",
}
```
---
## [**ConfigurationTimeTracking**]()
```json
{
"workingHoursPerDay": 8,
"workingDaysPerWeek": 5,
"timeFormat?": "'pretty' | 'days' | 'hours'",
"defaultUnit?": "'minute' | 'hour' | 'day' | 'week'",
}
```
---
## [**CreateMeta**]()
```json
{
"id": "string",
"description": "string",
"iconUrl": "string",
"name": "string",
"subtask": "boolean",
"avatarId": "number",
"expand": "string",
"fields": "{ [key: string]: FieldMeta }",
"self?": "string",
}
```
- See [**FieldMeta**](#fieldmeta) Definition.
---
## [**CustomField**]()
```json
{
"id": "string",
"name": "string",
"description": "string",
"type": "string",
"searchKey": "string",
"projectIds": "number[]",
"issueTypeIds": "string[]",
"numericId": "number",
"isLocked": "boolean",
"isManaged": "boolean",
"isAllProjects": "boolean",
"isTrusted": "boolean",
"projectsCount": "number",
"screensCount": "number",
"lastValueUpdate": "string",
"issuesWithValue": "number",
}
```
---
## [**CustomFieldDefinition**]()
```json
{
"id": "string",
"name": "string",
"description": "string",
"type": "string",
"searchKey": "string",
"projectIds": "number[]",
"issueTypeIds": "string[]",
}
```
---
## [**CustomFieldOption**]()
```json
{
"message": "string",
"deletedCustomFields": "string[]",
"notDeletedCustomFields": "string[]",
}
```
---
## [**Dashboard**]()
```json
{
"id": "string",
"name": "string",
"view": "string",
"self?": "string",
}
```
---
## [**DeletedFieldsOutput**]()
```json
{
"value": "string",
"disabled": "boolean",
"self?": "string",
}
```
---
## [**EditMeta**]()
```json
{
"fields": "{ [key: string]: FieldMeta }",
}
```
- See [**FieldMeta**](#fieldmeta) Definition.
---
## [**EntityProperty**]()
```json
{
"key": "string",
"value": "any",
}
```
---
## [**EntityPropertyKey**]()
```json
{
"key": "string",
"self?": "string",
}
```
---
## [**EntityPropertyKeys**]()
```json
{
"keys": "EntityPropertyKey[]",
}
```
- See [**EntityPropertyKey**](#entitypropertykey) Definition.
---
## [**Field**]()
```json
{
"id": "string",
"name": "string",
"custom": "boolean",
"orderable": "boolean",
"navigable": "boolean",
"searchable": "boolean",
"clauseNames": "string[]",
"schema": "FieldSchema",
}
```
- See [**FieldSchema**](#fieldschema) Definition.
---
## [**FieldSchema**]()
```json
{
"type": "string",
"items": "string",
"system": "string",
"custom": "string",
"customId": "number",
}
```
---
## [**Filter**]()
```json
{
"id": "string",
"name": "string",
"description": "string",
"owner": "User",
"jql": "string",
"viewUrl": "string",
"searchUrl": "string",
"favourite": "boolean",
"sharePermissions": "FilterPermission[]",
"sharedUsers": "ListWrapper",
"subscriptions": "ListWrapper",
"editable": "boolean",
}
```
- See [**ListWrapper**](#listwrapper) Definition.
- See [**FilterPermission**](#filterpermission) Definition.
- See [**FilterSubscription**](#filtersubscription) Definition.
- See [**User**](#user) Definition.
---
## [**FilterInput**]()
```json
{
"name": "string",
"description": "string",
"jql": "string",
"favourite": "boolean",
"editable": "boolean",
}
```
---
## [**FieldMeta**]()
```json
{
"required": "boolean",
"schema": "JsonType",
"name": "string",
"fieldId": "string",
"autoCompleteUrl": "string",
"hasDefaultValue": "boolean",
"operations": "string[]",
"allowedValues": "any[]",
"defaultValue": "any",
}
```
- See [**JsonType**](#jsontype) Definition.
---
## [**FilterPermission**]()
```json
{
"id": "string",
"type": "string",
"project": "Project",
"role": "ProjectRole",
"group": "Group",
"user": "User",
"view": "boolean",
"edit": "boolean",
}
```
- See [**User**](#user) Definition.
- See [**Group**](#group) Definition.
- See [**ProjectRole**](#projectrole) Definition.
- See [**Project**](#project) Definition.
---
## [**FilterPermissionInput**]()
```json
{
"groupname?": "string",
"userKey?": "string",
"type": "string",
"view": "boolean",
"edit": "boolean",
}
```
---
## [**FilterSubscription**]()
```json
{
"id": "number",
"user?": "User",
"group?": "Group",
}
```
---
## [**FilterSubscriptionInput**]()
```json
{
"user?": "User",
"group?": "Group",
}
```
---
## [**Group**]()
```json
{
"name": "string",
"users": "ListWrapper",
"expand": "string",
"self?": "string",
}
```
- See [**ListWrapper**](#listwrapper) Definition.
- See [**User**](#user) Definition.
---
## [**GroupSuggestions**]()
```json
{
"header": "string",
"total": "number",
"groups": "GroupSuggestion[]",
}
```
- See [**GroupSuggestion**](#groupsuggestion) Definition.
---
## [**GroupSuggestion**]()
```json
{
"name": "string",
"html": "string",
"labels?": "GroupSuggestionLabel[]",
}
```
- See [**GroupSuggestionLabel**](#groupsuggestionlabel) Definition.
---
## [**GroupSuggestionLabel**]()
```json
{
"text": "string",
"title": "string",
"type": "'ADMIN' | 'SINGLE' | 'MULTIPLE'",
}
```
---
## [**HistoryMetadata**]()
```json
{
"type": "string",
"description": "string",
"descriptionKey": "string",
"activityDescription": "string",
"activityDescriptionKey": "string",
"emailDescription": "string",
"emailDescriptionKey": "string",
"actor": "Participant",
"generator": "Participant",
"cause": "Participant",
"extraData": "{ [key: string]: string }",
}
```
- See [**Participant**](#participant) Definition.
---
## [**Icon**]()
```json
{
"url16x16": "string",
"title": "string",
"link": "string",
}
```
---
## [**Instance**]()
```json
{
"alias": "string",
"host": "string",
"token": "string",
}
```
---
## [**Issue**]()
```json
{
"expand": "string",
"id": "string",
"key": "string",
"fields": "{ [key: string]: any }",
"renderedFields": "{ [key: string]: any }",
"properties": {
"properties": "{ [key: string]: string }",
},
"names": "{ [key: string]: string }",
"schema": "{ [key: string]: JsonType }",
"transitions": "IssueTransition[]",
"operations": "LinkGroup[]",
"editmeta": "EditMeta",
"changelog": "ChangeLog",
"versionedRepresentations": "any",
"fieldsToInclude": "any",
}
```
- See [**JsonType**](#jsontype) Definition.
- See [**IssueTransition**](#issuetransition) Definition.
- See [**LinkGroup**](#linkgroup) Definition.
- See [**EditMeta**](#editmeta) Definition.
- See [**ChangeLog**](#changelog) Definition.
---
## [**IssueInput**]()
```json
{
"transition?": "IssueTransition",
"fields?": "{ [key: string]: any }",
"update?": "{ [key: string]: any[] }",
"historyMetadata?": "HistoryMetadata",
"properties?": "EntityProperty[]",
}
```
- See [**IssueTransition**](#issuetransition) Definition.
- See [**HistoryMetadata**](#historymetadata) Definition.
- See [**EntityProperty**](#entityproperty) Definition.
---
## [**IssueLink**]()
```json
{
"id": "string",
"key": "string",
"self?": "string",
}
```
---
## [**IssueLinks**]()
```json
{
"issues": "IssueLink[]",
"errors?": "string[]",
}
```
- See [**IssueLink**](#issuelink) Definition.
---
## [**IssueLinkType**]()
```json
{
"id": "string",
"name": "string",
"inward": "string",
"outward": "string",
"self?": "string",
}
```
---
## [**IssueLinkTypes**]()
```json
{
"issueLinkTypes": "IssueLinkType[]",
}
```
- See [**IssueLinkType**](#issuelinktype) Definition.
---
## [**IssuePicker**]()
```json
{
"key": "string",
"keyHtml": "string",
"img": "string",
"summary": "string",
"summaryText": "string",
}
```
---
## [**IssuePickerOutput**]()
```json
{
"sections": "IssuePickerSection[]",
}
```
- See [**IssuePickerSection**](#issuepickersection) Definition.
---
## [**IssuePickerSection**]()
```json
{
"label": "string",
"sub": "string",
"id": "string",
"msg": "string",
"issues": "IssuePicker[]",
}
```
- See [**IssuePicker**](#issuepicker) Definition.
---
## [**IssueNotification**]()
```json
{
"subject": "string",
"textBody": "string",
"htmlBody?": "string",
"to": "IssueNotificationTo",
"restrict": "IssueNotificationRetrict",
}
```
- See [**IssueNotificationTo**](#issuenotificationto) Definition.
- See [**IssueNotificationRetrict**](#issuenotificationretrict) Definition.
---
## [**IssueNotificationTo**]()
```json
{
"reporter?": "boolean",
"assignee?": "boolean",
"watchers?": "boolean",
"voters?": "boolean",
"users?": "User[]",
"groups?": "Group[]",
}
```
- See [**User**](#user) Definition.
- See [**Group**](#group) Definition.
---
## [**IssueNotificationPermission**]()
```json
{
"id": "string",
"key": "string",
}
```
---
## [**IssueNotificationRetrict**]()
```json
{
"groups?": "Group[]",
"permissions?": "IssueNotificationPermission[]",
}
```
- See [**Group**](#group) Definition.
- See [**IssueNotificationPermission**](#issuenotificationpermission) Definition.
---
## [**IssueReference**]()
```json
{
"id": "string",
"key": "string",
"fields": "IssueReferenceFields",
"user": "User",
}
```
- See [**IssueReferenceFields**](#issuereferencefields) Definition.
- See [**User**](#user) Definition.
---
## [**IssueReferenceFields**]()
```json
{
"summary": "string",
"status": "Status",
"issuetype": "IssueType",
"priority": "Priority",
}
```
- See [**Status**](#status) Definition.
- See [**IssueType**](#issuetype) Definition.
- See [**Priority**](#priority) Definition.
---
## [**IssueRemoteLink**]()
```json
{
"id": "number",
"globalId": "string",
"application": "Application",
"relationship": "string",
"object": "RemoteObject",
}
```
- See [**Application**](#application) Definition.
- See [**RemoteObject**](#remoteobject) Definition.
---
## [**IssueSecuritySchemes**]()
```json
{
"issueSecuritySchemes": "SecurityScheme[]",
}
```
- See [**SecurityScheme**](#securityscheme) Definition.
---
## [**IssueTransition**]()
```json
{
"id": "string",
"name": "string",
"opsbarSequence": "number",
"to": "Status",
"fields": "{ [key: string]: FieldMeta }",
"expand": "string",
}
```
- See [**FieldMeta**](#fieldmeta) Definition.
---
## [**IssueTransitions**]()
```json
{
"expand": "string",
"transitions": "IssueTransition[]",
}
```
- See [**IssueTransition**](#issuetransition) Definition.
---
## [**IssueTransitionInput**]()
```json
{
"transition": {
"id": "string",
},
"fields?": "{ [key: string]: any }",
"update?": "{ [key: string]: any[] }",
"historyMetadata?": "HistoryMetadata",
"properties?": "EntityProperty[]",
}
```
- See [**IssueTransition**](#issuetransition) Definition.
- See [**HistoryMetadata**](#historymetadata) Definition.
- See [**EntityProperty**](#entityproperty) Definition.
---
## [**IssueType**]()
```json
{
"id": "string",
"description": "string",
"iconUrl?": "string",
"name": "string",
"subtask": "boolean",
"avatarId?": "number",
}
```
---
## [**IssueTypeScheme**]()
```json
{
"id": "string",
"name": "string",
"description": "string",
"defaultIssueType": "IssueType",
"issueTypes": "IssueType[]",
"expand": "string",
}
```
- See [**IssueType**](#issuetype) Definition.
---
## [**IssueTypeSchemeList**]()
```json
{
"schemes": "IssueTypeScheme[]",
"self?": "string",
}
```
- See [**IssueTypeScheme**](#issuetypescheme) Definition.
---
## [**IssueVotes**]()
```json
{
"votes": "number",
"hasVoted": "boolean",
"voters": "User[]",
"self?": "string",
}
```
- See [**User**](#user) Definition.
---
## [**IssueWatchers**]()
```json
{
"isWatching": "boolean",
"watchCount": "number",
"watchers": "User[]",
"self?": "string",
}
```
- See [**User**](#user) Definition.
---
## [**JsonType**]()
```json
{
"type": "string",
"items?": "string",
"system": "string",
"custom": "string",
"customId": "number",
}
```
---
## [**LinkGroup**]()
```json
{
"id": "string",
"styleClass": "string",
"header": "SimpleLink",
"weight": "number",
"links": "SimpleLink[]",
"groups": "LinkGroup[]",
}
```
- See [**SimpleLink**](#simplelink) Definition.
---
## [**LinkIssue**]()
```json
{
"type": "IssueLinkType",
"inwardIssue": "IssueReference",
"outwardIssue": "IssueReference",
"comment?": "Comment",
}
```
- See [**IssueLinkType**](#issuelinktype) Definition.
- See [**IssueReference**](#issuereference) Definition.
- See [**Comment**](#comment) Definition.
---
## [**LinkIssueRequest**]()
```json
{
"type": {
"name": "string",
},
"inwardIssue": {
"key": "string",
},
"outwardIssue": {
"key": "string",
},
"comment?": "CommentInput",
}
```
- See [**CommentInput**](#commentinput) Definition.
---
## [**ListWrapper**]()
This type support **Generic Types** (**`T`**). That means can be of many types (The specified between <> symbols on parent definition)
```json
{
"size": "number",
"max-results?": "number",
"start-index?": "number",
"end-index?": "number",
"items": "T[]",
}
```
---
## [**Participant**]()
```json
{
"id": "string",
"displayName": "string",
"displayNameKey": "string",
"type": "string",
"avatarUrl": "string",
"url": "string",
}
```
---
## [**Permission**]()
```json
{
"key": "string",
"name": "string",
"type": "'GLOBAL' | 'PROJECT'",
"description": "string",
}
```
---
## [**PermissionGrant**]()
```json
{
"id": "number",
"holder": "PermissionHolder",
"permission": "string",
"self?": "string",
}
```
- See [**PermissionHolder**](#permissionholder) Definition.
---
## [**PermissionHolder**]()
```json
{
"type": "string",
"parameter": "string",
"user": "User",
"group": "Group",
"field": "Field",
"projecRtole": "ProjectRole",
"expand": "string",
}
```
- See [**ProjectRole**](#projectrole) Definition.
- See [**Field**](#field) Definition.
- See [**Group**](#group) Definition.
- See [**User**](#user) Definition.
---
## [**PermissionsOutput**]()
```json
{
"permisions": "{ [key: string]: Permission }",
}
```
- See [**Permission**](#permission) Definition.
---
## [**PermissionScheme**]()
```json
{
"id": "number",
"name": "string",
"description": "string",
"permissions": "PermissionGrant[]",
"expand": "string",
"self?": "string",
}
```
- See [**PermissionGrant**](#permissiongrant) Definition.
---
## [**PermissionSchemes**]()
```json
{
"permissionSchemes": "{ [key: string]: PermissionScheme }",
}
```
- See [**PermissionScheme**](#permissionscheme) Definition.
---
## [**Priority**]()
```json
{
"id": "string",
"statusColor": "string",
"description": "string",
"iconUrl": "string",
"name": "string",
}
```
---
## [**Project**]()
```json
{
"id": "string",
"key": "string",
"description": "string",
"lead?": "User",
"components?": "Component[]",
"issueTypes?": "IssueType[]",
"url": "string",
"email": "string",
"assigneeType": "'PROJECT_LEAD' | 'UNASSIGNED'",
"versions": "Version[]",
"name": "string",
"roles": "{ [key: string]: string }",
"avatarUrls": "{ [key: string]: string }",
"projectKeys": "string[]",
"projectCategory": "ProjectCategory",
"projectTypeKey": "string",
"archived": "boolean",
}
```
- See [**User**](#user) Definition.
- See [**Component**](#component) Definition.
- See [**IssueType**](#issuetype) Definition.
- See [**Version**](#version) Definition.
- See [**ProjectCategory**](#projectcategory) Definition.
---
## [**ProjectCategory**]()
```json
{
"id": "string",
"name": "string",
"description": "string",
}
```
---
## [**ProjectRole**]()
```json
{
"id": "string",
"name": "string",
"description": "string",
"actors": "RoleActor[]",
}
```
- See [**RoleActor**](#roleactor) Definition.
---
## [**RemoteEntityLink**]()
```json
{
"name": "string",
"link": "any",
}
```
---
## [**RemoteObject**]()
```json
{
"url": "string",
"title": "string",
"summary": "string",
"icon": "Icon",
"status": "RemoteObjectStatus",
}
```
- See [**RemoteObjectStatus**](#remoteobjectstatus) Definition.
- See [**Icon**](#icon) Definition.
---
## [**RemoteObjectStatus**]()
```json
{
"resolved": "boolean",
"icon": "Icon",
}
```
- See [**Icon**](#icon) Definition.
---
## [**RoleActor**]()
```json
{
"id": "string",
"name": "string",
"displayName": "string",
"type": "string",
"avatarUrl": "string",
}
```
## [**SecurityScheme**]()
```json
{
"id": "string",
"name": "string",
"description": "string",
"defaultSecurityLevelId": "number",
"levels": "SecuritySchemeLevel[]",
}
```
- See [**SecuritySchemeLevel**](#securityschemelevel) Definition.
## [**SecuritySchemeLevel**]()
```json
{
"id": "string",
"name": "string",
"description": "string",
}
```
---
## [**ShareScope**]()
```json
{
"scope": "'GLOBAL' | 'AUTHENTICATED' | 'PRIVATE'",
}
```
---
## [**SimpleLink**]()
```json
{
"id": "string",
"styleClass": "string",
"iconClass": "string",
"label": "string",
"title": "string",
"href": "string",
"weight": "number",
}
```
## [**Status**]()
```json
{
"id": "string",
"statusColor": "string",
"description": "string",
"iconUrl": "string",
"name": "string",
"statusCategory": "StatusCategory",
"self?": "string",
}
```
- See [**StatusCategory**](#statuscategory) Definition.
## [**StatusCategory**]()
```json
{
"id": "string",
"key": "string",
"colorName": "string",
"name": "string",
}
```
---
## [**SystemAvatars**]()
```json
{
"system": "Avatar[]"
}
```
- See [**Avatar**](#avatar) Definition.
---
## [**User**]()
```json
{
"key": "string",
"name": "string",
"emailAddress": "string",
"avatarUrls": "{ [key: string]: string }",
"displayName": "string",
"active": "boolean",
"deleted": "boolean",
"timeZone": "string",
"locale": "string",
"groups": "ListWrapper",
"applicationRoles": "ListWrapper",
"expand": "string",
"self?": "string",
}
```
- See [**ListWrapper**](#listwrapper) Definition.
- See [**Group**](#group) Definition.
- See [**ApplicationRole**](#applicationrole) Definition.
---
## [**UserPermission**]()
```json
{
"id": "string",
"key": "string",
"name": "string",
"type": "string",
"description": "string",
"havePermission": "boolean",
}
```
---
## [**UserPermissionsOutput**]()
```json
{
"permisions": "{ [key: string]: UserPermission }",
}
```
- See [**UserPermission**](#userpermission) Definition.
---
## [**Version**]()
```json
{
"id": "string",
"description": "string",
"name": "string",
"archived": "boolean",
"released": "boolean",
"overdue": "boolean",
"userStartDate": "string",
"userReleaseDate": "string",
"project": "string",
"projectId": "number",
"moveUnfixedIssuesTo": "string",
"operations": "SimpleLink[]",
"remotelinks": "RemoteEntityLink[]",
}
```
- See [**SimpleLink**](#simplelink) Definition.
- See [**RemoteEntityLink**](#remoteentitylink) Definition.
---
## [**Visibility**]()
```json
{
"type": "'group' | 'role'",
"value": "string",
}
```
---
## [**IssueWorklog**]()
```json
{
"id": "string",
"author": "User",
"updateAuthor": "User",
"comment": "string",
"created": "string",
"updated": "string",
"visibility": "Visibility",
"started": "string",
"timeSpent": "string",
"timeSpentSeconds": "number",
"issueId": "string",
"self?": "string",
}
```
- See [**Visibility**](#visibility) Definition.
- See [**User**](#user) Definition.
---
## [**IssueWorklogInput**]()
```json
{
"comment": "string",
"visibility": "Visibility",
"started": "string",
"timeSpentSeconds": "number",
}
```
- See [**Visibility**](#visibility) Definition.