{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/cpm/developer/rest-api/how-to/powershell/rest-using-powershell/","matchPath":"","result":{"data":{"markdownRemark":{"html":"

Celonis Process Management REST access using Powershell

\n

Pre-requisites

\n\n

Executing a REST command using Powershell

\n

The Invoke-RestMethod cmdlet sends HTTP and HTTPS requests to Representational State Transfer (REST) web services that returns richly structured data.

\n

PowerShell formats the response based to the data type.

\n

For more information please have a look at the documentation on Microsoft: Microsoft documentation

\n

Example script to get released processes or documents

\n
\n
\n
Copy
\n
Copied
\n
\n 
\tfunction Fetch_Data {\n\t\t[CmdletBinding()]\n\t\t# Parameters for collecting data\n\t\tparam(\n\t\t\t# Server address parameter\n\t\t\t[Parameter(Mandatory=$true, HelpMessage=\"Please enter the server address!\", Position=1)]\n\t\t\t[ValidateNotNullOrEmpty()]\n\t\t\t[string]$address,\n\n\t\t\t# Collection name parameter\n\t\t\t[Parameter(Mandatory=$true, HelpMessage=\"Please enter the collection name!\", Position=2)]\n\t\t\t[ValidateNotNullOrEmpty()]\n\t\t\t[string]$collection,\n\n\t\t\t# Storage name parameter\n\t\t\t[Parameter(Mandatory=$true, HelpMessage=\"Please enter the storage name!\", Position=3)]\n\t\t\t[ValidateNotNullOrEmpty()]\n\t\t\t[string]$storage,\n\n\t\t\t# REST API Token parameter\n\t\t\t[Parameter(Mandatory=$true, HelpMessage=\"Please enter the REST API token!\", Position=4)]\n\t\t\t[ValidateNotNullOrEmpty()]\n\t\t\t[string]$token,\n\t\t\n\t\t\t# Export data to file parameter. False is default. Parameter is not mandatory\n\t\t\t[Parameter(Mandatory=$false, HelpMessage=\"Export result in json file?\", Position=5)]\n\t\t\t[bool]$fileExport = $false\n\t\t)\n\n\t\tProcess\n\t\t{\n\t\t\ttry\n\t\t\t{\n\t\t\t\t$params = @{\n\t\t\t\t    Uri = \"https://$($address)/$($collection)/$($storage)/_api/rest/facets/processes/views/lastReleasedProcesses/elements\"\n\t\t\t\t    Headers = @{ 'symbio-auth-token' =  $token; 'api-version' = '2.0' }\n\t\t\t\t    Method = 'GET'\n\t\t\t\t    ContentType = 'application/json'\n\t\t\t\t}\n\n\t\t\t\t# Response of the API request. Data will be taken with depth of 10 levels\n\t\t\t\t$result = Invoke-RestMethod @params | ConvertTo-Json -Depth 10\n\n\t\t\t\t# Converting from JSON to table data (Easier for customization of fields and ordering)\n\t\t\t\t$tableResult = $result | ConvertFrom-Json\n\n\t\t\t\t$valuesResult = ''\n\n\t\t\t\t# All data is putting to one table object\n\t\t\t\t$hash = @{}\n\t\t\t\tforeach($row in $tableResult.PSObject.Properties){\n\t\t\t\tif($row.Value -is [int]) { continue }\n\t\t\t\t\t$hash[$row.Name] = $row.Value\n\t\t\t\t\t$valuesResult = $hash[$row.Name]\n\t\t\t\t}\n\n\t\t\t\t$arrayOfElements = New-Object System.Collections.ArrayList\n\n\t\t\t\t# Mapping all data to fields which will be shown to the final data\n\t\t\t\tforeach($element in $valuesResult)\n\t\t\t\t{\n\t\t\t\t\t$parameters = [ordered]@{\n\t\t\t\t\t\tName = $element.attributes.Name\n\t\t\t\t\t\tState = $element.attributes.state1\n\t\t\t\t\t\tType = $element.type\n\t\t\t\t\t\tLinkAddress = $element.attributes.links.'127'.fullAddress\n\t\t\t\t\t\tLinkTitle = $element.attributes.links.'127'.title\n\t\t\t\t\t} \n\t\t\t\t\t[void]$arrayOfElements.Add($parameters)\n\t\t\t\t}\n\n\t\t\t\t# Checking if the data is not empty\n\t\t\t\tif($arrayOfElements.Count -lt 1)\n\t\t\t\t{\n\t\t\t\t\tWrite-Host \"Response returned 0 elements. Please check input parameters, and try again...\"\n\t\t\t\t}\n\t\t\t\telse\n\t\t\t\t{\n                    # If the data isn't empty, it's checking if parameter export to file is True\n                    $file_export = $fileExport\n                    $today = Get-Date -Format yyyy-MM-ddTHH-mm-ss-ff\n                    if($file_export -eq $true) \n                    {\n                        $arrayOfElements | ConvertTo-Json | Out-File \".\\processes$($today).json\"\n                    }\n                    else { $arrayOfElements | ConvertTo-Json }\n\t\t\t\t}\n\t\t\t}\n\t\t\tcatch [System.Management.Automation.CommandNotFoundException]\n\t\t\t{\n\t\t\t\tWrite-Host \"Command not found. Please execute again...\"\n\t\t\t\tWrite-Host $_.ScriptStackTrace\n\t\t\t}\n\t\t\tcatch [System.Net.WebException],[System.SystemException]\n\t\t\t{\n\t\t\t\tWrite-Host \"Web error. Please check input parameters and try again.\"\n\t\t\t\tWrite-Host $_.ScriptStackTrace\n\t\t\t}\n\t\t}\n\t}
\n
\n

Example output

\n

The script can output the json directly, or create a file with the same content, depending on the $fileExport parameter.

\n
\n
\n
Copy
\n
Copied
\n
\n 
\t[\n\t\t{\n\t\t\t\"Name\":  {\n\t\t\t\t\t\t \"1033\":  \"Sub Process 1\",\n\t\t\t\t\t\t \"1031\":  \"Teilprozess 1\"\n\t\t\t\t\t },\n\t\t\t\"State\":  null,\n\t\t\t\"Type\":  \"subProcess\",\n\t\t\t\"LinkAddress\":  null,\n\t\t\t\"LinkTitle\":  null\n\t\t},\n\t\t{\n\t\t\t\"Name\":  {\n\t\t\t\t\t\t \"1033\":  \"Sub Process 2\",\n\t\t\t\t\t\t \"1031\":  \"Teilprozess 2\"\n\t\t\t\t\t },\n\t\t\t\"State\":  \"InProgress\",\n\t\t\t\"Type\":  \"subProcess\",\n\t\t\t\"LinkAddress\":  null,\n\t\t\t\"LinkTitle\":  null\n\t\t},\n\t\t{\n\t\t\t\"Name\":  {\n\t\t\t\t\t\t \"1033\":  \"Sub Process 3\",\n\t\t\t\t\t\t \"1031\":  \"Teilprozess 3\"\n\t\t\t\t\t },\n\t\t\t\"State\":  null,\n\t\t\t\"Type\":  \"subProcess\",\n\t\t\t\"LinkAddress\":  null,\n\t\t\t\"LinkTitle\":  null\n\t\t},\n\t]
\n
\n

How to call the Powershell script

\n

You can save the script in a ****.ps file.\nThe parameters are:

\n
    \n
  1. \nServer name\n
    2. \n
  2. \nStorage collection name\n
    3. \n
  3. \nStorage name\n
    4. \n
  4. \nAuthentication token\n
    5. \n
  5. \nFile export (true/false) (Optional parameter)\n
    6. \n
\n

Running it with user input

\n

When running the the script file without parameters, the script will prompt you to enter the required values. Using !? at that point will give you a hint on the required value.

\n

Running inline

\n

You can also run the script and provide the required parameters at runtime.\nExample:

\n
\n
-collection -storage -token -dataType 1 -fileExport false`, `55357967423382590000`)\"\n >\n
Copy
\n
Copied
\n
\n 
\trun.ps -address <servername> -collection <collection-name> -storage <storage-name> -token <auth-token> -dataType 1 -fileExport false
\n
","headings":[{"value":"Celonis Process Management REST access using Powershell","depth":1},{"value":"Pre-requisites","depth":2},{"value":"Executing a REST command using Powershell","depth":2},{"value":"Example script to get released processes or documents","depth":2},{"value":"Example output","depth":2},{"value":"How to call the Powershell script","depth":2},{"value":"Running it with user input","depth":3},{"value":"Running inline","depth":3}]},"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":"2adaeb4a-7e46-562b-8594-6a1946a063bd__redocly content/cpm/developer/rest-api/how-to/powershell/rest-using-powershell/","seo":{"title":"Celonis Process Management REST access using Powershell","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"cpm/developer/rest-api/how-to/powershell/rest-using-powershell.md","pageBaseUrl":"/cpm/developer/rest-api/how-to/powershell/rest-using-powershell","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Celonis Process Management REST access using Powershell","id":"celonis-process-management-rest-access-using-powershell"},{"depth":2,"value":"Pre-requisites","id":"pre-requisites"},{"depth":2,"value":"Executing a REST command using Powershell","id":"executing-a-rest-command-using-powershell"},{"depth":2,"value":"Example script to get released processes or documents","id":"example-script-to-get-released-processes-or-documents"},{"depth":2,"value":"Example output","id":"example-output"},{"depth":2,"value":"How to call the Powershell script","id":"how-to-call-the-powershell-script"},{"depth":3,"value":"Running it with user input","id":"running-it-with-user-input"},{"depth":3,"value":"Running inline","id":"running-inline"}]},"data":{"title":""},"catalogInfo":null,"link":"/cpm/developer/rest-api/how-to/powershell/rest-using-powershell/","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"]}