{"type":"doc","content":[{"type":"panel","attrs":{"panelIconId":"1f4e3","panelIcon":":mega:","panelIconText":"📣","panelColor":"#EAE6FF","panelType":"custom"},"content":[{"type":"heading","attrs":{"level":4},"content":[{"text":"API changes in Jira 10.","type":"text"}]},{"type":"paragraph","content":[{"text":"Starting from Jira 10, the APIs below use ","type":"text"},{"text":"/2/","type":"text","marks":[{"type":"code"}]},{"text":" instead of ","type":"text"},{"text":"/1/","type":"text","marks":[{"type":"code"}]},{"text":". This section provides examples for different Jira versions.","type":"text"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Get Options","type":"text"}]},{"type":"paragraph","content":[{"text":"Since version 4.0.9 the addon defines a REST call which provides information about options","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Jira 10","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"GET /rest/multi-level-cascading-select/2/option/getOptions","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Jira 9 and below","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"GET /rest/multi-level-cascading-select/1/option/getOptions","type":"text","marks":[{"type":"code"}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Query parameters:","type":"text"}]},{"type":"paragraph","content":[{"text":"fieldName","type":"text","marks":[{"type":"strong"}]},{"text":" (optional)","type":"text"},{"type":"hardBreak"},{"text":" name of the custom field (retrieve only fields with such name). If this parameter is not specified, options from fields with any name will be retrieved","type":"text"}]},{"type":"paragraph","content":[{"text":"projectKey","type":"text","marks":[{"type":"strong"}]},{"text":" (optional)","type":"text"},{"type":"hardBreak"},{"text":" the key of a project (retrieve only fields associated with such project). If this parameter is not specified, options from fields will be retrieved, regardless of the projects those fields associated with","type":"text"}]},{"type":"paragraph","content":[{"text":"anyType","type":"text","marks":[{"type":"strong"}]},{"text":" (optional, defaults to \"false\")","type":"text"},{"type":"hardBreak"},{"text":" if this is set to true, the method will retrieve not just the options of MultiLevelCascadeSelect fields but of any kind of field which uses options (ie, classes implementing the Option interface). This is known to be well-behaved on Jira Cascade Select fields, but of course there could be no guarantee on all other possible fields which make use of Option implementations","type":"text"}]},{"type":"paragraph","content":[{"text":"fieldConfigId","type":"text","marks":[{"type":"strong"}]},{"text":" (optional)","type":"text"},{"type":"hardBreak"},{"text":" relevant config id. This parameter is optional, but when it is specified, parameters 'fieldName' and 'projectKey'must not be used (parameters are essentially filters for fieldConfigs, so if the ID of a fieldConfig is specified, it makes no sense to use other filters, as ID is unique). If 'anyType=true' is used, then the method will try to get information about options even if the field is not of type MultiLevelCascadeSelect (see 'anyType').","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Response:","type":"text"}]},{"type":"paragraph","content":[{"text":"The options are described by a JSON structure, containing the fields","type":"text"}]},{"type":"paragraph","content":[{"text":"optionId","type":"text","marks":[{"type":"strong"}]},{"text":" - ","type":"text"},{"text":"number","type":"text","marks":[{"type":"em"}]},{"text":", the (JIRA-wise) unique id number of the option","type":"text"}]},{"type":"paragraph","content":[{"text":"value","type":"text","marks":[{"type":"strong"}]},{"text":" - ","type":"text"},{"text":"string","type":"text","marks":[{"type":"em"}]},{"text":", the value of the option","type":"text"}]},{"type":"paragraph","content":[{"text":"sequence","type":"text","marks":[{"type":"strong"}]},{"text":" - ","type":"text"},{"text":"number","type":"text","marks":[{"type":"em"}]},{"text":", the place that the option occupies among its silblings","type":"text"}]},{"type":"paragraph","content":[{"text":"disabled","type":"text","marks":[{"type":"strong"}]},{"text":" - ","type":"text"},{"text":"boolean","type":"text","marks":[{"type":"em"}]},{"text":", it is true if the option is disabled","type":"text"}]},{"type":"paragraph","content":[{"text":"fildConfigId","type":"text","marks":[{"type":"strong"}]},{"text":" - ","type":"text"},{"text":"number","type":"text","marks":[{"type":"em"}]},{"text":", the ID of the field config to which the option belongs","type":"text"}]},{"type":"paragraph","content":[{"text":"children","type":"text","marks":[{"type":"strong"}]},{"text":" - ","type":"text"},{"text":"array of option objects","type":"text","marks":[{"type":"em"}]},{"text":", the child-options of the option","type":"text"}]},{"type":"paragraph","content":[{"text":"Example","type":"text","marks":[{"type":"em"}]},{"text":":","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"optionId\": 10504,\n \"value\": \"Europe\",\n \"sequence\": 0,\n \"disabled\": false,\n \"fieldConfigId\": 10108,\n \"children\": [\n {\n \"optionId\": 10505,\n \"value\": \"Italy\",\n \"sequence\": 0,\n \"disabled\": false,\n \"fieldConfigId\": 10108\n },\n {\n \"optionId\": 10506,\n \"value\": \"France\",\n \"sequence\": 1,\n \"disabled\": false,\n \"fieldConfigId\": 10108\n }\n ]\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Add Option","type":"text"}]},{"type":"paragraph","content":[{"text":"Add a new option as a child of the input parent option. If no parent option is specified, a new root (level 0) option is added.","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Jira 10","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"POST /rest/multi-level-cascading-select/2/option/","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Jira 9 and below","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"POST /rest/multi-level-cascading-select/1/option/","type":"text","marks":[{"type":"code"}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Query parameters:","type":"text"}]},{"type":"paragraph","content":[{"text":"fieldConfigId","type":"text","marks":[{"type":"strong"}]},{"text":" (required)","type":"text"},{"type":"hardBreak"},{"text":" id of the field configuration of the custom field (","type":"text"},{"text":"warning","type":"text","marks":[{"type":"underline"},{"type":"strong"},{"type":"em"}]},{"text":": 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)","type":"text"}]},{"type":"paragraph","content":[{"text":"parentOptionId","type":"text","marks":[{"type":"strong"}]},{"text":" (optional)","type":"text"},{"type":"hardBreak"},{"text":" if specified, the new option will be added as a child option of the one identified by this parameter. If not specified, the new option will be a root option","type":"text"}]},{"type":"paragraph","content":[{"text":"optionValue","type":"text","marks":[{"type":"strong"}]},{"text":" (required)","type":"text"},{"type":"hardBreak"},{"text":" the value of the new option (this must be different from all sibling options values, not be equal to \"Any\", not be case-insensitively equal to \"none\")","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Response:","type":"text"}]},{"type":"paragraph","content":[{"text":"If everything goes well, response status is 200 and response body contains details about the new option, like its ID.","type":"text"}]},{"type":"paragraph","content":[{"text":"The option is described by a json structure, containing the fields","type":"text"}]},{"type":"paragraph","content":[{"text":"optionId","type":"text","marks":[{"type":"strong"}]},{"text":" - ","type":"text"},{"text":"number","type":"text","marks":[{"type":"em"}]},{"text":", the (JIRA-wise) unique id number of the option","type":"text"}]},{"type":"paragraph","content":[{"text":"value","type":"text","marks":[{"type":"strong"}]},{"text":" - ","type":"text"},{"text":"string","type":"text","marks":[{"type":"em"}]},{"text":", the value of the option","type":"text"}]},{"type":"paragraph","content":[{"text":"sequence","type":"text","marks":[{"type":"strong"}]},{"text":" - ","type":"text"},{"text":"number","type":"text","marks":[{"type":"em"}]},{"text":", the place that the option occupies among its silblings","type":"text"}]},{"type":"paragraph","content":[{"text":"Example","type":"text","marks":[{"type":"em"}]},{"text":":","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"optionId\": 10505,\n \"value\": \"Italy\",\n \"sequence\": 1\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Delete Option","type":"text"}]},{"type":"paragraph","content":[{"text":"Remove an option.","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Jira 10","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"DELETE /rest/multi-level-cascading-select/2/option/{optionId}","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Jira 9 and below","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"DELETE /rest/multi-level-cascading-select/1/option/{optionId}","type":"text","marks":[{"type":"code"}]}]}]},{"type":"paragraph","content":[{"text":"where:","type":"text"}]},{"type":"paragraph","content":[{"text":"optionId","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":" id of the option to remove ","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Query parameters:","type":"text"}]},{"type":"paragraph","content":[{"text":"fieldConfigId","type":"text","marks":[{"type":"strong"}]},{"text":" (required)","type":"text"},{"type":"hardBreak"},{"text":" id of the field configuration of the custom field (","type":"text"},{"text":"warning","type":"text","marks":[{"type":"underline"},{"type":"strong"},{"type":"em"}]},{"text":": 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)","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Response:","type":"text"}]},{"type":"paragraph","content":[{"text":"If everything goes well, response status is 200 and response body is empty.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Rename Option","type":"text"}]},{"type":"paragraph","content":[{"text":"Modify the value of an option","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Jira 10","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"PUT /rest/multi-level-cascading-select/2/option/{optionId}","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Jira 9 and below","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"PUT /rest/multi-level-cascading-select/1/option/{optionId}","type":"text","marks":[{"type":"code"}]}]}]},{"type":"paragraph","content":[{"text":"where:","type":"text"}]},{"type":"paragraph","content":[{"text":"optionId","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":" id of the option to rename ","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Query parameters:","type":"text"}]},{"type":"paragraph","content":[{"text":"newValue","type":"text","marks":[{"type":"strong"}]},{"text":" (required)","type":"text"},{"type":"hardBreak"},{"text":" the new value of the option (this must be different from all sibling options values, not be equal to \"Any\", not be case-insensitively equal to \"none\")","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Response:","type":"text"}]},{"type":"paragraph","content":[{"text":"If everything goes well, response status is 200 and response body contains details about the option.","type":"text"}]},{"type":"paragraph","content":[{"text":"The option is described by a json structure, containing the fields","type":"text"}]},{"type":"paragraph","content":[{"text":"optionId","type":"text","marks":[{"type":"strong"}]},{"text":" - ","type":"text"},{"text":"number","type":"text","marks":[{"type":"em"}]},{"text":", the (JIRA-wise) unique id number of the option","type":"text"}]},{"type":"paragraph","content":[{"text":"value","type":"text","marks":[{"type":"strong"}]},{"text":" - ","type":"text"},{"text":"string","type":"text","marks":[{"type":"em"}]},{"text":", the value of the option","type":"text"}]},{"type":"paragraph","content":[{"text":"sequence","type":"text","marks":[{"type":"strong"}]},{"text":" - ","type":"text"},{"text":"number","type":"text","marks":[{"type":"em"}]},{"text":", the place that the option occupies among its silblings","type":"text"}]},{"type":"paragraph","content":[{"text":"Example","type":"text","marks":[{"type":"em"}]},{"text":":","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"optionId\": 10505,\n \"value\": \"Italy\",\n \"sequence\": 1\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Disable Option","type":"text"}]},{"type":"paragraph","content":[{"text":"Make an option not selectable.","type":"text"}]},{"type":"panel","attrs":{"panelIconId":"1f4d8","panelIcon":":blue_book:","panelIconText":"📘","panelColor":"#DEEBFF","panelType":"custom"},"content":[{"type":"paragraph","content":[{"text":"Jira 10","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"PUT /rest/multi-level-cascading-select/2/option/{optionId}/disable","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Jira 9 and below","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"PUT /rest/multi-level-cascading-select/1/option/{optionId}/disable","type":"text","marks":[{"type":"code"}]}]}]},{"type":"paragraph","content":[{"text":"where:","type":"text"}]},{"type":"paragraph","content":[{"text":"optionId","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":" id of the option to disable.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Response:","type":"text"}]},{"type":"paragraph","content":[{"text":"If everything goes well, response status is 200 and response body contains details about the option.","type":"text"}]},{"type":"paragraph","content":[{"text":"The option is described by a json structure, containing the fields","type":"text"}]},{"type":"paragraph","content":[{"text":"optionId","type":"text","marks":[{"type":"strong"}]},{"text":" - ","type":"text"},{"text":"number","type":"text","marks":[{"type":"em"}]},{"text":", the (JIRA-wise) unique id number of the option","type":"text"}]},{"type":"paragraph","content":[{"text":"value","type":"text","marks":[{"type":"strong"}]},{"text":" - ","type":"text"},{"text":"string","type":"text","marks":[{"type":"em"}]},{"text":", the value of the option","type":"text"}]},{"type":"paragraph","content":[{"text":"sequence","type":"text","marks":[{"type":"strong"}]},{"text":" - ","type":"text"},{"text":"number","type":"text","marks":[{"type":"em"}]},{"text":", the place that the option occupies among its silblings","type":"text"}]},{"type":"paragraph","content":[{"text":"Example","type":"text","marks":[{"type":"em"}]},{"text":":","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"optionId\": 10505,\n \"value\": \"Italy\",\n \"sequence\": 1\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Enable Option","type":"text"}]},{"type":"paragraph","content":[{"text":"Make an option selectable.","type":"text"}]},{"type":"panel","attrs":{"panelIconId":"1f4d8","panelIcon":":blue_book:","panelIconText":"📘","panelColor":"#DEEBFF","panelType":"custom"},"content":[{"type":"paragraph","content":[{"text":"Jira 10","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"PUT /rest/multi-level-cascading-select/2/option/{optionId}/enable","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Jira 9 and below","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"PUT /rest/multi-level-cascading-select/1/option/{optionId}/enable","type":"text","marks":[{"type":"code"}]}]}]},{"type":"paragraph","content":[{"text":"where:","type":"text"}]},{"type":"paragraph","content":[{"text":"optionId","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":" id of the option to enable ","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Response:","type":"text"}]},{"type":"paragraph","content":[{"text":"If everything goes well, response status is 200 and response body contains details about the option.","type":"text"}]},{"type":"paragraph","content":[{"text":"The option is described by a json structure, containing the fields","type":"text"}]},{"type":"paragraph","content":[{"text":"optionId","type":"text","marks":[{"type":"strong"}]},{"text":" - ","type":"text"},{"text":"number","type":"text","marks":[{"type":"em"}]},{"text":", the (JIRA-wise) unique id number of the option","type":"text"}]},{"type":"paragraph","content":[{"text":"value","type":"text","marks":[{"type":"strong"}]},{"text":" - ","type":"text"},{"text":"string","type":"text","marks":[{"type":"em"}]},{"text":", the value of the option","type":"text"}]},{"type":"paragraph","content":[{"text":"sequence","type":"text","marks":[{"type":"strong"}]},{"text":" - ","type":"text"},{"text":"number","type":"text","marks":[{"type":"em"}]},{"text":", the place that the option occupies among its silblings","type":"text"}]},{"type":"paragraph","content":[{"text":"Example","type":"text","marks":[{"type":"em"}]},{"text":":","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"optionId\": 10505,\n \"value\": \"Italy\",\n \"sequence\": 1\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Move Option","type":"text"}]},{"type":"paragraph","content":[{"text":"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. ","type":"text"}]},{"type":"panel","attrs":{"panelIconId":"1f4d8","panelIcon":":blue_book:","panelIconText":"📘","panelColor":"#DEEBFF","panelType":"custom"},"content":[{"type":"paragraph","content":[{"text":"Jira 10","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"PUT /rest/multi-level-cascading-select/2/option/{optionId}/position","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Jira 9 and below","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"PUT /rest/multi-level-cascading-select/1/option/{optionId}/position","type":"text","marks":[{"type":"code"}]}]}]},{"type":"paragraph","content":[{"text":"where:","type":"text"}]},{"type":"paragraph","content":[{"text":"optionId","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":" id of the option to enable ","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Query parameters:","type":"text"}]},{"type":"paragraph","content":[{"text":"fieldConfigId","type":"text","marks":[{"type":"strong"}]},{"text":" (required)","type":"text"},{"type":"hardBreak"},{"text":" id of the field configuration of the custom field (","type":"text"},{"text":"warning","type":"text","marks":[{"type":"underline"},{"type":"strong"},{"type":"em"}]},{"text":": 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)","type":"text"}]},{"type":"paragraph","content":[{"text":"position","type":"text","marks":[{"type":"strong"}]},{"text":" (required, must be between 0 and the number of sibling options - 1)","type":"text"},{"type":"hardBreak"},{"text":" the position where the option must be placed (first position is 0)","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Response:","type":"text"}]},{"type":"paragraph","content":[{"text":"If everything goes well, response status is 200 and response body is empty.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Sort Options","type":"text"}]},{"type":"paragraph","content":[{"text":"Alphabetically sort the child options of the input parent option. If no parent option is specified, sort the root level options.","type":"text"}]},{"type":"panel","attrs":{"panelIconId":"1f4d8","panelIcon":":blue_book:","panelIconText":"📘","panelColor":"#DEEBFF","panelType":"custom"},"content":[{"type":"paragraph","content":[{"text":"Jira 10","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"GET /rest/multi-level-cascading-select/2/option/sort","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Jira 9 and below","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"GET /rest/multi-level-cascading-select/1/option/sort","type":"text","marks":[{"type":"code"}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Query parameters:","type":"text"}]},{"type":"paragraph","content":[{"text":"fieldConfigId","type":"text","marks":[{"type":"strong"}]},{"text":" (required)","type":"text"},{"type":"hardBreak"},{"text":" id of the field configuration of the custom field (","type":"text"},{"text":"warning","type":"text","marks":[{"type":"underline"},{"type":"strong"},{"type":"em"}]},{"text":": 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)","type":"text"}]},{"type":"paragraph","content":[{"text":"asc","type":"text","marks":[{"type":"strong"}]},{"text":" (optional)","type":"text"},{"type":"hardBreak"},{"text":" if this parameter is given, options are sorted in reverse (ascending) order","type":"text"}]},{"type":"paragraph","content":[{"text":"parentOptionId","type":"text","marks":[{"type":"strong"}]},{"text":" (optional)","type":"text"},{"type":"hardBreak"},{"text":" if specified, the child options of the one identified by this parameter will be sorted. If not specified, root options will be sorted","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Response:","type":"text"}]},{"type":"paragraph","content":[{"text":"If everything goes well, response status is 200 and response body is empty.","type":"text"}]}],"version":1}

Browser not supported