REST API
This version is deprecated. Please migrate to the latest version.
Rest API Endpoint Documentation
This is the static documentation for the Customfield Editor for Jira's REST-API.
The baseUrl of the REST API might be one of the following URLs on your instance of Jira:
- http[s]://server:port/jira/rest/jiracustomfieldeditorplugin/1.1/*
- http[s]://server:port/rest/jiracustomfieldeditorplugin/1.1/*
You need to use Basic Authentication for every request to the API.
user-custom-field-operations
/user/customfieldoption/{customfieldid}
Creates a new option for the customfield.
Parameter | Description | Data Type | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
customfieldid | type: path required: true | string default: customfield_12345 | ||||||||||||||||||||||||||||||||||||
body | type: body required: false Don't set id and childOptions they will be ignored. Only set optionvalue and disabled. You should not set sequence, because you could damage the order of all options. | object
{ "childOptions": [ { "disabled": false, "id": 0, "optionvalue": "foo", "sequence": 0 } ], "disabled": false, "id": 0, "optionvalue": "foo", "sequence": 0 } |
/user/customfieldoptions/{customfieldid}
list all options of a customfield. childOptions is optional and only present if the customfield's type is cascading field. You can try the api it is mocked for the customfieldId customfield_12345.
Parameter | Description | Data Type |
---|---|---|
customfieldid | type: path required: true | string default: customfield_12345 |
/user/customfieldoption/{customfieldid}/{optionid}
Deletes an option of the customfield by its id.
Parameter | Description | Data Type |
---|---|---|
customfieldid | type: path required: true | string default: customfield_12345 |
optionid | type: path required: true | integer default: 123 |
/user/customfieldoption/{customfieldid}/{optionid}
Updates the value of an existing option for the customfield.
Parameter | Description | Data Type | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
customfieldid | type: path required: true | string default: customfield_12345 | ||||||||||||||||||||||||||||||||||||
optionid | type: path required: true | integer default: 123 | ||||||||||||||||||||||||||||||||||||
body | type: body required: false If you set _sequence_ to a number, you will destroy the internal order of options. So do not set sequence directly, use the reorder request instead. If you set sequence, be sure to set it for all options. For example: You want alphabetic order and you set a new sequence value for every option starting from 0, you will be fine. | object
{ "childOptions": [ { "disabled": false, "id": 0, "optionvalue": "foo", "sequence": 0 } ], "disabled": false, "id": 0, "optionvalue": "foo", "sequence": 0 } |
/user/customfieldoption/{customfieldid}/{optionid}/move
Change order for existing option of customfield depending on values of RestfulTableMoveModel.
Parameter | Description | Data Type | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
customfieldid | type: path required: true | string default: customfield_12345 | |||||||||
optionid | type: path required: true | integer default: 123 | |||||||||
body | type: body required: true Object containing move instructions. You either set **position**=First or set **after**=optionIdToMoveAfter. Don't set both, position will be used! | object
{ "after": "foo", "position": "foo" } |
/user/customfieldchildoption/{customfieldid}/{parentoptionid}
Creates a new child-option on the parent-option for the customfield.
Parameter | Description | Data Type | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
customfieldid | type: path required: true | string default: customfield_12345 | ||||||||||||||||||||||||||||||||||||
parentoptionid | type: path required: true | integer default: 123 | ||||||||||||||||||||||||||||||||||||
body | type: body required: false Don't set id and childOptions they will be ignored. Only set optionvalue and disabled. You should not set sequence, because you could damage the order of all options. | object
{ "childOptions": [ { "disabled": false, "id": 0, "optionvalue": "foo", "sequence": 0 } ], "disabled": false, "id": 0, "optionvalue": "foo", "sequence": 0 } |
/user/customfieldchildoptions/{customfieldid}/{parentoptionid}
Lists child-options of parent-option. childOptions will be empty.
Parameter | Description | Data Type |
---|---|---|
customfieldid | type: path required: true | string default: customfield_12345 |
parentoptionid | type: path required: true | integer default: 123 |
/user/customfieldchildoption/{customfieldid}/{parentoptionid}/{childoptionid}
Deletes an child-option of an parent-option of the customfield by its id.
Parameter | Description | Data Type |
---|---|---|
customfieldid | type: path required: true | string default: customfield_12345 |
parentoptionid | type: path required: true | integer default: 123 |
childoptionid | type: path required: true | integer default: 334 |
/user/customfieldchildoption/{customfieldid}/{parentoptionid}/{childoptionid}
Updates the value of an existing child-option of a parent-option for the customfield.
Parameter | Description | Data Type | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
customfieldid | type: path required: true | string default: customfield_12345 | ||||||||||||||||||||||||||||||||||||
parentoptionid | type: path required: true | integer default: 123 | ||||||||||||||||||||||||||||||||||||
childoptionid | type: path required: true | integer default: 334 | ||||||||||||||||||||||||||||||||||||
body | type: body required: false If you set _sequence_ to a number, you will destroy the internal order of options. So do not set sequence directly, use the reorder request instead. If you set sequence, be sure to set it for all options. For example: You want alphabetic order and you set a new sequence value for every option starting from 0, you will be fine. | object
{ "childOptions": [ { "disabled": false, "id": 0, "optionvalue": "foo", "sequence": 0 } ], "disabled": false, "id": 0, "optionvalue": "foo", "sequence": 0 } |
/user/customfieldchildoption/{customfieldid}/{parentoptionid}/{childoptionid}/move
Change order for existing child-option of parent-option of customfield depending on values of RestfulTableMoveModel.
Parameter | Description | Data Type | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
customfieldid | type: path required: true | string default: customfield_12345 | |||||||||
parentoptionid | type: path required: true | integer default: 123 | |||||||||
childoptionid | type: path required: true | integer default: 334 | |||||||||
body | type: body required: true Object containing move instructions. You either set **position**=First or set **after**=optionIdToMoveAfter. Don't set both, position will be used! | object
{ "after": "foo", "position": "foo" } |