Administration API
- Adam Labus
Owned by Adam Labus
Jun 13, 2022
24 min read
Loading data...
This feature has been replaced by Configuration Helper - Jira configuration
Deprecated since version 1.35.*
Removed since version 1.51.*
General information
Available ONLY for JIRA administrators
Get duplicated screens
This API searches all screens and finds those that have the same fields regardless of their position.
As a result, we receive detailed information about similar screens (tabs and fields), based on which
we can take appropriate actions to remove duplicate screens or their unificationMethod type - GET
URL:
- {JIRA_URL}/rest/extender/1.0/administration/screens/getDuplicates
Response format - JSON
Example request:
Several users
{
"total": 4,
"screens": [
{
"screenId": 10003,
"sameFields": [
{
"screenId": 10004,
"details": {
"sameTabsOrder": true,
"sameTabsName": true,
"sameFieldsOrder": true,
"sameTabsNumber": true,
"sameFieldsInTabs": true
},
"screenName": "Screen 2"
},
{
"screenId": 10005,
"details": {
"sameTabsOrder": false,
"sameTabsName": false,
"sameFieldsOrder": true,
"sameTabsNumber": false,
"sameFieldsInTabs": false
},
"screenName": "Screen 3"
},
{
"screenId": 10006,
"details": {
"sameTabsOrder": false,
"sameTabsName": false,
"sameFieldsOrder": false,
"sameTabsNumber": false,
"sameFieldsInTabs": false
},
"screenName": "Screen 4"
}
],
"screenName": "Screen 1"
},
{
"screenId": 10004,
"sameFields": [
{
"screenId": 10003,
"details": {
"sameTabsOrder": true,
"sameTabsName": true,
"sameFieldsOrder": true,
"sameTabsNumber": true,
"sameFieldsInTabs": true
},
"screenName": "Screen 1"
},
{
"screenId": 10005,
"details": {
"sameTabsOrder": false,
"sameTabsName": false,
"sameFieldsOrder": true,
"sameTabsNumber": false,
"sameFieldsInTabs": false
},
"screenName": "Screen 3"
},
{
"screenId": 10006,
"details": {
"sameTabsOrder": false,
"sameTabsName": false,
"sameFieldsOrder": false,
"sameTabsNumber": false,
"sameFieldsInTabs": false
},
"screenName": "Screen 4"
}
],
"screenName": "Screen 2"
},
{
"screenId": 10005,
"sameFields": [
{
"screenId": 10003,
"details": {
"sameTabsOrder": false,
"sameTabsName": false,
"sameFieldsOrder": true,
"sameTabsNumber": false,
"sameFieldsInTabs": false
},
"screenName": "Screen 1"
},
{
"screenId": 10004,
"details": {
"sameTabsOrder": false,
"sameTabsName": false,
"sameFieldsOrder": true,
"sameTabsNumber": false,
"sameFieldsInTabs": false
},
"screenName": "Screen 2"
},
{
"screenId": 10006,
"details": {
"sameTabsOrder": true,
"sameTabsName": true,
"sameFieldsOrder": false,
"sameTabsNumber": true,
"sameFieldsInTabs": false
},
"screenName": "Screen 4"
}
],
"screenName": "Screen 3"
},
{
"screenId": 10006,
"sameFields": [
{
"screenId": 10003,
"details": {
"sameTabsOrder": false,
"sameTabsName": false,
"sameFieldsOrder": false,
"sameTabsNumber": false,
"sameFieldsInTabs": false
},
"screenName": "Screen 1"
},
{
"screenId": 10004,
"details": {
"sameTabsOrder": false,
"sameTabsName": false,
"sameFieldsOrder": false,
"sameTabsNumber": false,
"sameFieldsInTabs": false
},
"screenName": "Screen 2"
},
{
"screenId": 10005,
"details": {
"sameTabsOrder": true,
"sameTabsName": true,
"sameFieldsOrder": false,
"sameTabsNumber": true,
"sameFieldsInTabs": false
},
"screenName": "Screen 3"
}
],
"screenName": "Screen 4"
}
],
"maxResults": 1000,
"startAt": 0
}
Get duplicated fields configuration
This API scans all configurations and finds those that have the same required fields or the same hidden fields.
As a result, we receive information about similar configurations, based on which we can take appropriate actions
to remove duplicate screens or their unification.Method type - GET
URL:
- {JIRA_URL}/rest/extender/1.0/administration/fieldsConfiguration/getDuplicates
Response format - JSON
Example request:
Several users
{
"total": 4,
"maxResults": 1000,
"fieldConfigurations": [
{
"sameFieldConfiguration": [
{
"details": {
"sameFieldsHidden": true,
"sameFieldsDescription": true,
"sameFieldsRequired": false
},
"fieldConfigurationId": 10100,
"fieldConfigurationName": "Field Configuration 1"
},
{
"details": {
"sameFieldsHidden": true,
"sameFieldsDescription": false,
"sameFieldsRequired": true
},
"fieldConfigurationId": 10102,
"fieldConfigurationName": "Field Configuration 3"
},
{
"details": {
"sameFieldsHidden": true,
"sameFieldsDescription": true,
"sameFieldsRequired": false
},
"fieldConfigurationId": 10103,
"fieldConfigurationName": "Field Configuration 4"
}
],
"fieldConfigurationId": 10000,
"fieldConfigurationName": "Default Field Configuration"
},
{
"sameFieldConfiguration": [
{
"details": {
"sameFieldsHidden": true,
"sameFieldsDescription": true,
"sameFieldsRequired": false
},
"fieldConfigurationId": 10000,
"fieldConfigurationName": "Default Field Configuration"
},
{
"details": {
"sameFieldsHidden": true,
"sameFieldsDescription": false,
"sameFieldsRequired": false
},
"fieldConfigurationId": 10102,
"fieldConfigurationName": "Field Configuration 3"
},
{
"details": {
"sameFieldsHidden": true,
"sameFieldsDescription": true,
"sameFieldsRequired": true
},
"fieldConfigurationId": 10103,
"fieldConfigurationName": "Field Configuration 4"
}
],
"fieldConfigurationId": 10100,
"fieldConfigurationName": "Field Configuration 1"
},
{
"sameFieldConfiguration": [
{
"details": {
"sameFieldsHidden": true,
"sameFieldsDescription": false,
"sameFieldsRequired": true
},
"fieldConfigurationId": 10000,
"fieldConfigurationName": "Default Field Configuration"
},
{
"details": {
"sameFieldsHidden": true,
"sameFieldsDescription": false,
"sameFieldsRequired": false
},
"fieldConfigurationId": 10100,
"fieldConfigurationName": "Field Configuration 1"
},
{
"details": {
"sameFieldsHidden": true,
"sameFieldsDescription": false,
"sameFieldsRequired": false
},
"fieldConfigurationId": 10103,
"fieldConfigurationName": "Field Configuration 4"
}
],
"fieldConfigurationId": 10102,
"fieldConfigurationName": "Field Configuration 3"
},
{
"sameFieldConfiguration": [
{
"details": {
"sameFieldsHidden": true,
"sameFieldsDescription": true,
"sameFieldsRequired": false
},
"fieldConfigurationId": 10000,
"fieldConfigurationName": "Default Field Configuration"
},
{
"details": {
"sameFieldsHidden": true,
"sameFieldsDescription": true,
"sameFieldsRequired": true
},
"fieldConfigurationId": 10100,
"fieldConfigurationName": "Field Configuration 1"
},
{
"details": {
"sameFieldsHidden": true,
"sameFieldsDescription": false,
"sameFieldsRequired": false
},
"fieldConfigurationId": 10102,
"fieldConfigurationName": "Field Configuration 3"
}
],
"fieldConfigurationId": 10103,
"fieldConfigurationName": "Field Configuration 4"
}
],
"startAt": 0
}
Pagination
This REST API uses pagination to improve performance for all Jira users. Pagination is enforced for methods that could return a large collection of items. When you make a request to a paged API, the response will wrap the returned array of values in a JSON object with paging metadata, for example:
{
"startAt" : 0,
"maxResults" : 10,
"total": 200,
"fieldConfigurations": [
{ /* result 0 */ },
{ /* result 1 */ },
{ /* result 2 */ }
]
}
{
"startAt" : 0,
"maxResults" : 10,
"total": 200,
"screens": [
{ /* result 0 */ },
{ /* result 1 */ },
{ /* result 2 */ }
]
}
Where:
startAtis the index of the first item returned in the page of results.maxResultsis the maximum number of items that can be returned per page. Each API endpoint may have a different limit for the number of items returned, and these limits may change without notice. (default value - 1000)totalis the total number of items contained in all pages. This number may change as the client requests the subsequent pages, therefore the client should always assume that the requested page can be empty.
Example:
- {JIRA_URL}/rest/extender/1.0/administration/screens/getDuplicates?startAt=10&maxResults=20
- {JIRA_URL}/rest/extender/1.0/administration/screens/getDuplicates?maxResults=1000