{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Permalinks API (Legacy)","description":"API documentation for Celonis APIs.","siteUrl":"https://developer.celonis.com/","keywords":"celonis developer portal, celonis apis, celonis api reference docs","lang":"en-US","llmstxt":{"hide":false,"description":"Celonis API documentation","sections":[{"title":"API Docs","description":"Available Celonis API Docs","includeFiles":["**/*.md"],"excludeFiles":[]},{"title":"API Specs","description":"All Celonis API specifications","includeFiles":["**/openapi.yaml"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"permalinks-api-legacy","__idx":0},"children":["Permalinks API (Legacy)"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Important warning"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The legacy APIs in this section are not recommended for new implementations. It is recommended that you use the APIs from the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/cpm/developer/openapi/openapi"},"children":["Business Manager"]}," section for your integrations with the Celonis Platform."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use these APIs to work with permanent links to Celonis Process Management entities. Possible Celonis Process Management entities include:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Processes"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Specific versions of processes"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Specific selections (e.g. task, event, role) within processes"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Repository elements"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Overview pages"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can access the Swagger definition of these APIs using this URL: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://pz.symbioweb.com/swagger/index.html?url=/swagger/v1/swagger.json#/PermalinksV1"]},". Just replace ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["pz.symbioweb.com"]}," with the hostname (and port) of your Celonis Process Management instance."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"scenarios","__idx":1},"children":["Scenarios"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["GET"]}," endpoint to request information about possible permanent link types and already existing permanent links of an entity: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://pz.symbioweb.com/swagger/index.html?url=/swagger/v1/swagger.json#/PermalinksV1/PermalinksV1_GetPermaLinkInfo"]},", e.g."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"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\n"},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["POST"]}," endpoint to get or create a new permanent link of a given type for an entity: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://pz.symbioweb.com/swagger/index.html?url=/swagger/v1/swagger.json#/PermalinksV1/PermalinksV1_GetOrCreatePermaLink"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"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: {\"linkType\":\"ofVersion\"}\n"},"children":[]}]}]}]},"headings":[{"value":"Permalinks API (Legacy)","id":"permalinks-api-legacy","depth":1},{"value":"Scenarios","id":"scenarios","depth":2}],"frontmatter":{"seo":{"title":"Permalinks API (Legacy)"}},"lastModified":"2026-06-16T21:43:37.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/cpm/developer/rest-api/overview/permalinks-api","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}