Page History

...

If everything goes well, response status is 200 and response body is empty.

Rename Option

Modify the value of an option

PUT <jira-base>/rest/multi-level-cascading-select/1/option/{optionId}

where

optionId
    id of the option to rename 

Query parameters:

newValue (required)
    the new value of the option (warning: using this call you could set the value of an option to be the same of the value of a sibling option, and this can break the value-based JQL searches. Do not do that unless you are forced, and use only ID-based JQL searches if your environment contains sibling options having the same value)

Response:

If everything goes well, response status is 200 and response body contains details about the option.

The option is described by a json structure, containing the fields

optionId - number, the (JIRA-wise) unique id number of the option

value - string, the value of the option

sequence - number, the place that the option occupies among its silblings

Example:

{
    "optionId": 10505,
    "value": "Italy",
    "sequence": 1
}

Disable Option

Make an option not selectable

PUT <jira-base>/rest/multi-level-cascading-select/1/option/{optionId}/disable

where

optionId
    id of the option to disable 

Response:

If everything goes well, response status is 200 and response body contains details about the option.

The option is described by a json structure, containing the fields

optionId - number, the (JIRA-wise) unique id number of the option

value - string, the value of the option

sequence - number, the place that the option occupies among its silblings

Example:

{
    "optionId": 10505,
    "value": "Italy",
    "sequence": 1
}

Enable Option

Make an option selectable

PUT <jira-base>/rest/multi-level-cascading-select/1/option/{optionId}/enable

where

optionId
    id of the option to enable 

Response:

If everything goes well, response status is 200 and response body contains details about the option.

The option is described by a json structure, containing the fields

optionId - number, the (JIRA-wise) unique id number of the option

value - string, the value of the option

sequence - number, the place that the option occupies among its silblings

Example:

{
    "optionId": 10505,
    "value": "Italy",
    "sequence": 1
}

Move Option

Change the order of the option among its sibling options so that it is repositioned to the given place. The way other options are moved is better explained by an example: suppose we have options in the sequence 0,A - 1,B - 2,C - 3,D - 4,E. If we move B to position 3, we get: 0,A - 1,C - 2,D - 3,B - 4,E.  

PUT <jira-base>/rest/multi-level-cascading-select/1/option/{optionId}/position

where

optionId
    id of the option to enable 

Query parameters:

fieldConfigId (required)
    id of the field configuration of the custom field (warning: this is not the same thing as the custom field id. If you don't know the field config id, use the getOption REST call without any parameter and you will get the fieldConfigId for all of your MLCS custom fields)

position (required, must be between 0 and the number of sibling options - 1)
    the position where the option must be placed (first position is 0)