Which API Call Should Be Used To Extract The Process Description Using Orchestrator Cloud API?

News Knowledge Base
1

Which API call is needed to extract the process description using Orchestrator Cloud API?

Issue Description/Question/Requirement:

It is required to build an internal report, but the processes descriptions cannot be obtained using the Orchestrator Cloud API.

Which API needs to use in order to extract the process description using Orchestrator Cloud API?

Resolution:

  1. Run a GET request for the /odata/Releases endpoint and in the end, use the $select parameter to display only the necessary fields.

  1. The Bearer access_token needs to have OR.Execution or OR.Execution.Read permissions to successfully make the GET for the /odata/Releases API calls.

Example:

URL:

https://cloud.uipath.com/YOUR_ORG_NAME/YOUR_TENANT_NAME/orchestrator_/odata/Releases?$filter=ProcessKey eq 'YOUR_PROCESS_NAME'&$select=Key,ProcessKey,ProcessVersion,IsLatestVersion,IsProcessDeleted,Description,Name,EnvironmentId,EnvironmentName,EntryPointId,InputArguments,ProcessType,SupportsMultipleEntryPoints,RequiresUserInteraction,IsAttended,IsCompiled,AutomationHubIdeaUrl,AutoUpdate,FeedId,JobPriority,SpecificPriorityValue,OrganizationUnitId,OrganizationUnitFullyQualifiedName,TargetFramework,RobotSize,AutoCreateConnectedTriggers,RemoteControlAccess,LastModificationTime,LastModifierUserId,CreationTime,CreatorUserId,Id,Arguments,ProcessSettings,VideoRecordingSettings,Tags,ResourceOverwrites

Method: GET

Headers:

Authorization: Bearer YOUR_ACCESS_TOKEN

X-UIPATH-OrganizationUnitId: YOUR_FOLDER_ID

2.png

1.png