This page tells you, which REST APIs you can use provided by the Enterprise Theme.
On this page:
Menu
With these endpoints you can retrieve all informations of the configured menu structure.
/rest/enterprisetheme/1.0/menu/all.json
Returns a list of all menus.
[
{
"title": "Default Header",
"id": ""
},
{
"title": "Default Footer",
"id": "BV__FOOTER"
}
]
/rest/enterprisetheme/1.0/menu/entries.json
Returns all children menu entries of a specific node. If there is no query parameter, the top menu entries of the Global Header for the language of the current user is returned.
| Parameter | Value |
|---|---|
| menuIdentifier | The Menu identifier |
| identifier | The identifier of the parent menu enrty. |
Examples:
/rest/enterprisetheme/1.0/menu/entries.json
[
{
"id": "69fd42b9-a0ec-4aec-b9fe-6d8c13216f8c",
"text": "Example Menu Entry",
"href": "#",
"children": 0,
"className": "LINK"
},
{
"id": "5c3541d0-d8ce-45f6-8152-d4330ed4b710",
"text": "Submenu",
"href": "#",
"children": 3,
"className": "LINK"
},
{
"id": "12162d70-b006-4e71-a781-9574b00a7f2a",
"text": "Mega Menu",
"href": "#",
"children": 2,
"className": "LINK"
}
]
/rest/enterprisetheme/1.0/menu/entries.json?menuIdentifier=BV_FOOTER
[
{
"id": "69fd42b9-a0ec-4aec-b9fe-6d8c13216f8c",
"text": "Example Menu Entry",
"href": "#",
"children": 0,
"className": "LINK"
},
{
"id": "5c3541d0-d8ce-45f6-8152-d4330ed4b710",
"text": "Submenu",
"href": "#",
"children": 3,
"className": "LINK"
},
{
"id": "12162d70-b006-4e71-a781-9574b00a7f2a",
"text": "Mega Menu",
"href": "#",
"children": 2,
"className": "LINK"
}
]
/rest/enterprisetheme/1.0/menu/entries.json?identifier=12162d70-b006-4e71-a781-9574b00a7f2a
[
{
"id": "dd313822-4441-4302-b58f-cccf2c481e1f",
"text": "Submenu 1",
"href": "#",
"children": 2,
"className": "LINK"
},
{
"id": "458e9df7-7803-4e8f-ae0f-d99e72ef99b3",
"text": "Submenu 2",
"href": "#",
"children": 2,
"className": "LINK"
}
]
Confluence Content Objects
rest/enterprisetheme/1.0/search/pages
Returns a list of pages. This endpoint is used in the Enterprise Theme for autocomplete fields.
| Parameter | Value |
|---|---|
| q | A query term to filter the results |
| spaceKey | An optional spaceKey, to receive the results for a certain space. |
/rest/enterprisetheme/1.0/search/pages?q=w
[
{
"id": 98308,
"name": "_Approvals Workflow",
"spaceKey": "ds",
"spaceName": "Demonstration Space",
"contentType": "page"
},
{
"id": 98334,
"name": "Welcome to the Confluence Demonstration Space",
"spaceKey": "ds",
"spaceName": "Demonstration Space",
"contentType": "page"
}
]
rest/enterprisetheme/1.0/search/blogs
Returns a list of blogs. This endpoint is used in the Enterprise Theme for autocomplete fields.
| Parameter | Value |
|---|---|
| q | A query term to filter the results. |
| spaceKey | An optional spaceKey, to receive the results for a certain space. |
/rest/enterprisetheme/1.0/search/blogs?q=w
[
{
"id": 98345,
"name": "Movember at Atlassian - Oooo we're half way there, oooooo oh...",
"spaceKey": "ds",
"spaceName": "Demonstration Space",
"contentType": "blog"
}
]
rest/enterprisetheme/1.0/search/content
Returns a list of pages. This endpoint is used in the Enterprise Theme for autocomplete fields.
| Parameter | Value |
|---|---|
| q | A query term to filter the results. |
| spaceKey | An optional spaceKey, to receive the results for a certain space. |
/rest/enterprisetheme/1.0/search/content?q=we
[
{
"id": 98334,
"name": "Welcome to the Confluence Demonstration Space",
"spaceKey": "ds",
"spaceName": "Demonstration Space",
"contentType": "page"
},
{
"id": 98345,
"name": "Movember at Atlassian - Oooo we're half way there, oooooo oh...",
"spaceKey": "ds",
"spaceName": "Demonstration Space",
"contentType": "blog"
}
]
rest/enterprisetheme/1.0/search/groups
Returns a list of groups. This endpoint is used in the Enterprise Theme for autocomplete fields.
| Parameter | Value |
|---|---|
| q | A query term to filter the results. |
/rest/enterprisetheme/1.0/search/groups?q=ad
[
{
"id": "confluence-administrators",
"name": "confluence-administrators"
}
]
rest/enterprisetheme/1.0/search/users
Returns a list of users. This endpoint is used in the Enterprise Theme for autocomplete fields.
| Parameter | Value |
|---|---|
| q | A query term to filter the results. |
/rest/enterprisetheme/1.0/search/users?q=ad
[
{
"id": "admin",
"name": "admin"
}
]
Atlassian Team Calendars
rest/enterprisetheme/1.0/subcalendars
Returns a list of all subcalendars of the Atlassian Team Calendars add-on.
The response returns the current installed version of the Atlassian Tean Calendars add-on and a boolean value, if the current Enterprise Theme is compatible with this version.
/rest/enterprisetheme/1.0/subcalendars.json
{
"subcalendars":{
"76d8b02e-e4fb-4217-8283-63962a23e590":{
"title":"Reise",
"id":"76d8b02e-e4fb-4217-8283-63962a23e590",
"eventType":"travel",
"colour":"subcalendar-yellow",
"description":"",
"icon":"/download/resources/com.atlassian.confluence.extra.team-calendars:calendar-resources/img/travel_12.png",
"name":"Kalender 1",
"storeKey":"com.atlassian.confluence.extra.calendar3.calendarstore.generic.TravelSubCalendarDataStore",
"parentId":"44327240-ed06-4424-93ad-3a7ed37f2bb0"
},
"9d65914d-5cc0-4f75-af84-de1bf228c371":{
"title":"Uni",
"id":"9d65914d-5cc0-4f75-af84-de1bf228c371",
"eventType":"custom",
"colour":"subcalendar-green4",
"description":"",
"icon":"/download/resources/com.atlassian.confluence.extra.team-calendars:calendar-resources/img/customeventtype/training.png",
"name":"Eigenen",
"storeKey":"com.atlassian.confluence.extra.calendar3.calendarstore.generic.CustomSubCalendarDataStore",
"parentId":"0c0b0a79-33ce-4d9a-9d2e-fc14fc53e617"
}
},
"compatible":true,
"version":"5.0.5"
}
