{
"opencollection": "1.0.0",
"info": {
"name": "Atlassian Admin Account UI Modifications (Apps) API",
"version": "1.0.0"
},
"request": {
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"items": [
{
"info": {
"name": "UI Modifications (Apps)",
"type": "folder"
},
"items": [
{
"info": {
"name": "Atlassian Update Ui Modification",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.atlassian.com/rest/api/3/uiModifications/:uiModificationId",
"params": [
{
"name": "uiModificationId",
"value": "",
"type": "path",
"description": "The ID of the UI modification."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates a UI modification. UI modification can only be updated by Forge apps.
Each UI modification can define up to 1000 contexts. The same context can be assigned to maximum 100 UI modifications.
**[Permissions](#permissions) required:**
* *None* if the UI modification is created without contexts.
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, if the UI modification is created with contexts."
},
{
"info": {
"name": "Atlassian Delete Ui Modification",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.atlassian.com/rest/api/3/uiModifications/:uiModificationId",
"params": [
{
"name": "uiModificationId",
"value": "",
"type": "path",
"description": "The ID of the UI modification."
}
]
},
"docs": "Deletes a UI modification. All the contexts that belong to the UI modification are deleted too. UI modification can only be deleted by Forge apps.
**[Permissions](#permissions) required:** None."
},
{
"info": {
"name": "Atlassian Get Ui Modifications",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/rest/api/3/uiModifications",
"params": [
{
"name": "startAt",
"value": "",
"type": "query",
"description": "The index of the first item to return in a page of results (page offset)."
},
{
"name": "maxResults",
"value": "",
"type": "query",
"description": "The maximum number of items to return per page."
},
{
"name": "expand",
"value": "",
"type": "query",
"description": "Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `data` Returns UI modification data.\n * `contexts` Returns UI modification contexts."
}
]
},
"docs": "Gets UI modifications. UI modifications can only be retrieved by Forge apps.
**[Permissions](#permissions) required:** None."
},
{
"info": {
"name": "Atlassian Create Ui Modification",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.atlassian.com/rest/api/3/uiModifications",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a UI modification. UI modification can only be created by Forge apps.
Each app can define up to 3000 UI modifications. Each UI modification can define up to 1000 contexts. The same context can be assigned to maximum 100 UI modifications.
**[Permissions](#permissions) required:**
* *None* if the UI modification is created without contexts.
* *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, if the UI mod"
}
]
}
],
"bundled": true
}