{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/cpm/developer/rest-api/overview/permalinks-api/","matchPath":"","result":{"data":{"markdownRemark":{"html":"<h1 style=\"position:relative;\"><a href=\"#permalinks-api\" aria-label=\"permalinks api permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"permalinks-api\"></div>Permalinks API</h1>\n<p>Use these APIs to work with permanent links to Celonis Process Management entities. Possible Celonis Process Management entities include:</p>\n<ul>\n<li>\nProcesses\n</li>\n<li>\nSpecific versions of processes\n</li>\n<li>\nSpecific selections (e.g. task, event, role) within processes\n</li>\n<li>\nRepository elements\n</li>\n<li>\nOverview pages\n</li>\n</ul>\n<p>You can access the Swagger definition of these APIs using this URL: <code class=\"language-text\">https://pz.symbioweb.com/swagger/index.html?url=/swagger/v1/swagger.json#/PermalinksV1</code> - replace \"pz.symbioweb.com\" with the hostname (and port) of your Celonis Process Management instance.</p>\n<h2 style=\"position:relative;\"><a href=\"#scenarios\" aria-label=\"scenarios permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"scenarios\"></div>Scenarios</h2>\n<ul>\n<li>\nUse the \n<strong>GET</strong>\n endpoint to request information about possible permanent link types and already existing permanent links of an entity: \n<code class=\"language-text\">https://pz.symbioweb.com/swagger/index.html?url=/swagger/v1/swagger.json#/PermalinksV1/PermalinksV1_GetPermaLinkInfo</code>\n, e.g.\n<div class=\"code-wrapper\">\n        <div class=\"gatsby-code-button-container\"\n             data-toaster-id=\"72708453403808694000\"\n             data-toaster-duration=\"1500\"\n             onClick=\"copyCodeToClipboard(`GET https://pz.symbioweb.com/Collection/Storage/_api/v1/permalinks?facetName=Processes&facetViewKey=PersonalizedDiagram&contextKey=6ec75354-72f7-4f3b-a002-da8fc7b4d261&variantKey=&versionKey=6ec75354-72f7-4f3b-a002-da8fc7b4d261&selectionKey=&routeData[storagecollection]=Collection&routeData[tenant]=Storage&routeData[data]=editor&routeData[lcid]=1033&routeData[controller]=Facet&routeData[action]=Index&routeData[extension]=html&routeData[id]=Processes&routeData[area]=BasePlugin&routeData[routeName]=BasePlugin_default_extension&routeData[preview]=false&routeData[compilationId]=38428a2e-1d92-4aaf-9a19-5586e8087b17&routeData[subId]=treeanddiagram&routeData[renderMode]=Detailed`, `72708453403808694000`)\"\n        >\n          <div class=\"gatsby-code-button\" title=\"Copy the code snippet\">Copy</div>\n          <div class=\"done-indicator done-indicator-72708453403808694000\">Copied</div>\n        </div>\n        <div class=\"gatsby-highlight\" data-language=\"text\"><pre class=\"language-text\"><code class=\"language-text\">GET https://pz.symbioweb.com/Collection/Storage/_api/v1/permalinks?facetName=Processes&amp;facetViewKey=PersonalizedDiagram&amp;contextKey=6ec75354-72f7-4f3b-a002-da8fc7b4d261&amp;variantKey=&amp;versionKey=6ec75354-72f7-4f3b-a002-da8fc7b4d261&amp;selectionKey=&amp;routeData[storagecollection]=Collection&amp;routeData[tenant]=Storage&amp;routeData[data]=editor&amp;routeData[lcid]=1033&amp;routeData[controller]=Facet&amp;routeData[action]=Index&amp;routeData[extension]=html&amp;routeData[id]=Processes&amp;routeData[area]=BasePlugin&amp;routeData[routeName]=BasePlugin_default_extension&amp;routeData[preview]=false&amp;routeData[compilationId]=38428a2e-1d92-4aaf-9a19-5586e8087b17&amp;routeData[subId]=treeanddiagram&amp;routeData[renderMode]=Detailed</code></pre></div>\n      </div>\n</li>\n<li>\nUse the \n<strong>POST</strong>\n endpoint to get or create a new permanent link of a given type for an entity: \n<code class=\"language-text\">https://pz.symbioweb.com/swagger/index.html?url=/swagger/v1/swagger.json#/PermalinksV1/PermalinksV1_GetOrCreatePermaLink</code>\n<div class=\"code-wrapper\">\n        <div class=\"gatsby-code-button-container\"\n             data-toaster-id=\"27962274087175156000\"\n             data-toaster-duration=\"1500\"\n             onClick=\"copyCodeToClipboard(`POST https://pz.symbioweb.com/Collection/Storage/_api/v1/permalinks?facetName=Processes&facetViewKey=PersonalizedDiagram&contextKey=6ec75354-72f7-4f3b-a002-da8fc7b4d261&variantKey=&versionKey=6ec75354-72f7-4f3b-a002-da8fc7b4d261&selectionKey=&routeData[storagecollection]=Collection&routeData[tenant]=Storage&routeData[data]=editor&routeData[lcid]=1033&routeData[controller]=Facet&routeData[action]=Index&routeData[extension]=html&routeData[id]=Processes&routeData[area]=BasePlugin&routeData[routeName]=BasePlugin_default_extension&routeData[preview]=false&routeData[compilationId]=38428a2e-1d92-4aaf-9a19-5586e8087b17&routeData[subId]=treeanddiagram&routeData[renderMode]=Detailed\nJSON body: {&quot;linkType&quot;:&quot;ofVersion&quot;}`, `27962274087175156000`)\"\n        >\n          <div class=\"gatsby-code-button\" title=\"Copy the code snippet\">Copy</div>\n          <div class=\"done-indicator done-indicator-27962274087175156000\">Copied</div>\n        </div>\n        <div class=\"gatsby-highlight\" data-language=\"text\"><pre class=\"language-text\"><code class=\"language-text\">POST https://pz.symbioweb.com/Collection/Storage/_api/v1/permalinks?facetName=Processes&amp;facetViewKey=PersonalizedDiagram&amp;contextKey=6ec75354-72f7-4f3b-a002-da8fc7b4d261&amp;variantKey=&amp;versionKey=6ec75354-72f7-4f3b-a002-da8fc7b4d261&amp;selectionKey=&amp;routeData[storagecollection]=Collection&amp;routeData[tenant]=Storage&amp;routeData[data]=editor&amp;routeData[lcid]=1033&amp;routeData[controller]=Facet&amp;routeData[action]=Index&amp;routeData[extension]=html&amp;routeData[id]=Processes&amp;routeData[area]=BasePlugin&amp;routeData[routeName]=BasePlugin_default_extension&amp;routeData[preview]=false&amp;routeData[compilationId]=38428a2e-1d92-4aaf-9a19-5586e8087b17&amp;routeData[subId]=treeanddiagram&amp;routeData[renderMode]=Detailed\nJSON body: {\"linkType\":\"ofVersion\"}</code></pre></div>\n      </div>\n</li>\n</ul>","headings":[{"value":"Permalinks API","depth":1},{"value":"Scenarios","depth":2}]},"contentItem":{"data":{"lastModified":"2025-09-10T14:16:09.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":false,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"d68e338f-fe69-5ab5-ba30-c4932a20708a__redocly content/cpm/developer/rest-api/overview/permalinks-api/","seo":{"title":"Permalinks API","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"cpm/developer/rest-api/overview/permalinks-api.md","pageBaseUrl":"/cpm/developer/rest-api/overview/permalinks-api","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Permalinks API","id":"permalinks-api"},{"depth":2,"value":"Scenarios","id":"scenarios"}]},"data":{"title":""},"catalogInfo":null,"link":"/cpm/developer/rest-api/overview/permalinks-api/","sidebarName":"celonis","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":null,"apiVersionId":null,"isDefaultApiVersion":null}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}