Use Ankra's Overview layout for an application
import requests
url = "https://platform.ankra.app/api/v1/org/applications/{application_id}/overview-layout/use-ankra"
payload = { "base_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({base_revision_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};
fetch('https://platform.ankra.app/api/v1/org/applications/{application_id}/overview-layout/use-ankra', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url https://platform.ankra.app/api/v1/org/applications/{application_id}/overview-layout/use-ankra \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"base_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'{
"on_page": "ankra",
"revision": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"number": 2,
"content": "<string>",
"author_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"author_name": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"versions": 1
}{
"detail": "<string>"
}{
"detail": "<string>",
"error_code": "canvas_revision_conflict",
"current_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"layout": {
"on_page": "ankra",
"revision": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"number": 2,
"content": "<string>",
"author_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"author_name": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"versions": 1
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Applications
Use Ankra's Overview layout for an application
Puts the application’s Overview back on Ankra’s layout. No version is written or removed: every saved version stays in the list and can be put back. base_revision_id works as on a save (409 when the Overview changed since). Asking while the Overview already shows Ankra’s layout changes nothing and answers it. Audited on the application when it changes something. Requires applications.write.
POST
/
api
/
v1
/
org
/
applications
/
{application_id}
/
overview-layout
/
use-ankra
Use Ankra's Overview layout for an application
import requests
url = "https://platform.ankra.app/api/v1/org/applications/{application_id}/overview-layout/use-ankra"
payload = { "base_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({base_revision_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};
fetch('https://platform.ankra.app/api/v1/org/applications/{application_id}/overview-layout/use-ankra', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url https://platform.ankra.app/api/v1/org/applications/{application_id}/overview-layout/use-ankra \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"base_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'{
"on_page": "ankra",
"revision": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"number": 2,
"content": "<string>",
"author_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"author_name": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"versions": 1
}{
"detail": "<string>"
}{
"detail": "<string>",
"error_code": "canvas_revision_conflict",
"current_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"layout": {
"on_page": "ankra",
"revision": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"number": 2,
"content": "<string>",
"author_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"author_name": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"versions": 1
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Body
application/json
Response
The Overview shows Ankra's layout
What an application's Overview shows: Ankra's layout, which the page draws and Ankra does not store, or a version the team saved.