jira update-custom-field
Updates a custom field.
Description
Updates a custom field.
Synopsis
jira update-custom-field
--site <site>
--field_id <field_id>
[--name <name>]
[--description <description>]
[--searcher_key <searcher_key>]
Arguments
site
- (string)
Example: --site "site-1"
Default: localhost:8081
Attributes: required
field_id
- (string)
The ID of the custom field.
Example: --field_id "field_id-1"
Default: _None_
Attributes: required
name
- (string)
The name of the custom field.
Example: --name "name-1"
Default: _None_
Attributes: optional
description
- (string)
The description of the custom field.
Example: --description "description-1"
Default: _None_
Attributes: optional
searcher_key
- (string)
The searcher that defines the way the field is searched in Jira.
Example: --searcher_key "searcher_key-1"
Default: _None_
Attributes: optional
Validation:
allowed values: cascadingselectsearcher, daterange, datetimerange, exactnumber, exacttextsearcher, grouppickersearcher, labelsearcher, multiselectsearcher, numberrange, projectsearcher, textsearcher, userpickergroupsearcher, versionsearcher
Examples
jira update-custom-field --field_id "field_id-1" --name "name-1" --description "description-1" --searcher_key "searcher_key-1"
Access Control
To use this command, you need access to the following:
Field | Value |
---|---|
Action | "update" |
Service Type | "jira" |
Service Instance | |
Namespace | |
Object Type | "field" |
Object ID | field_id |
Please see Access Control for details.