Overview
Configuration is provided for establishing connections with UiPath Robotic Process Automation (RPA) platform via its REST API. The configuration is used in the REST Connection Manager.
Demonstration
Quick Start
In this task, we will show you step-by-step how to create a connection to UiPath Online REST API using COZYROC's REST Connection Manager.
Step 1. Go to UiPath "API Access" page by following the instructions posted here. You have to grab the following parameters:
- Account logical name
- Tenant logical name
- Client Id
- User Key
Step 2. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 3. From drop down menu Configuration select UiPath. You have 2 types of authentication. Select: Online. Enter the UiPath parameters you have acquired from "API Access" page in the places shown in the screenshot.
Step 4. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your UiPath instance.
In this guide, we will show how to read data from UiPath service resource using COZYROC REST Source component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.
Step 3. Double click on the "REST Source" component and select UiPath connection from the combo. Select from available UiPath resources listed in the second combo below.
Optionally you can include extra parameters in the grid below if needed.
Step 4. Click on the "Columns tab" and select UiPath resource columns you want to read.
Step 5. Click Preview to make sure all necessary resource columns are included.
Bravo! You have now learned how to read data from UiPath service.
In this guide, we will show how to write data to UiPath service resource using the COZYROC REST Destination component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.
Step 3. Double click on the "REST Destination" component and select UiPath connection from the combo. Also, select resource action and UiPath resource you want to work on.
Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into UiPath resource.
Configuration
Base URL address: https://platform.uipath.com/[AccountLogicalName]/[TenantLogicalName].
- Online
-
The authentication uses a session token.
The authentication has the following user-defined parameters:
- TenantLogical:
- ClientId:
- UserKey:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}} -
X-UIPATH-TenantName:
{{=connection.user.TenantLogical}}
Documentation: https://docs.uipath.com/orchestrator/reference#section-getting-the-api-access-information-from-the-cloud-platform-s-ui.
- Token
-
The authentication uses a session token.
The authentication has the following user-defined parameters:
- Tenant:
- User:
- Password:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://docs.uipath.com/orchestrator/reference#authenticating.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/api/logs.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Logs/Logs_Post.
- message
Template: ShortText.
- level
Template: ShortText.
- timeStamp
Template: DateTime. A read-only field.
- windowsIdentity
Template: ShortText.
- agentSessionId
Template: Id.
- processName
Template: ShortText.
- fileName
Template: ShortText.
- jobId
Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/api/Maintenance/Get.
The result is extracted from:{{=response.maintenanceLogs}}.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Maintenance/Maintenance_Get.
- state
Template: ShortText.
- timeStamp
Template: DateTime.
Based on resource template Base.
- [Read Entities] action
-
Endpoint URL address:
/api/Stats/GetCountStats.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Stats/Stats_GetCountStats.
- [Read Robots] action
-
Endpoint URL address:
/api/Stats/GetSessionsStats.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Stats/Stats_GetSessionsStats.
- [Read Jobs] action
-
Endpoint URL address:
/api/Stats/GetJobsStats.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Stats/Stats_GetJobsStats.
- title
Template: ShortText.
- count
Data type: DT_I4
- hasPermissions
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/odata/Alerts.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Alerts/Alerts_GetAlerts.
- [Create] action
-
Endpoint URL address:
/odata/Alerts/UiPath.Server.Configuration.OData.RaiseProcessAlert.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Alerts/Alerts_RaiseProcessAlert.
- Id
A key field. Template: Id.
- NotificationName
Template: ShortText.
- Data
Template: ShortText.
- Component
Template: ShortText.
- Severity
Template: ShortText.
- CreationTime
Template: DateTime.
- State
Template: ShortText.
- UserNotificationId
Template: Id.
- Message
Template: LongText.
- RobotName
Template: ShortText.
- ProcessName
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/odata/Assets.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Assets/Assets_GetAssets.
- [Create] action
-
Endpoint URL address:
/odata/Assets.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Assets/Assets_Post.
- [Update] action
-
Endpoint URL address:
/odata/Assets({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Assets/Assets_PutById.
- [Delete] action
-
Endpoint URL address:
/odata/Assets({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Assets/Assets_DeleteById.
- Id
Data type: DT_I4
- Name
Template: ShortText.
- CanBeDeleted
Data type: DT_BOOL
- ValueScope
Template: ShortText.
- ValueType
Template: ShortText.
- Value
Template: ShortText.
- StringValue
Template: ShortText.
- BoolValue
Data type: DT_BOOL
- IntValue
Data type: DT_I4
- CredentialUsername
Template: ShortText.
- CredentialPassword
Template: ShortText.
- ExternalName
Template: ShortText.
- CredentialStoreId
Data type: DT_I4
- KeyValueList
Field components:
- An array.
- Contains the following components: Key, Value.
- HasDefaultValue
Data type: DT_BOOL
- Description
Template: LongText.
- RobotValues
Field components:
- An array.
- Contains the following components: RobotId, RobotName, KeyTrail, ValueType, StringValue, BoolValue, IntValue, Value, CredentialUsername, CredentialPassword, ExternalName, CredentialStoreId, KeyValueList, Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/odata/AuditLogs.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/AuditLogs/AuditLogs_GetAuditLogs.
- Id
Data type: DT_I4
- ServiceName
Template: ShortText.
- MethodName
Template: ShortText.
- Parameters
Template: ShortText.
- ExecutionTime
Template: ShortText.
- Action
Template: ShortText.
- Component
Template: ShortText.
- DisplayName
Template: ShortText.
- EntityId
Data type: DT_I4
- OperationText
Template: ShortText.
- UserName
Template: ShortText.
- UserType
Template: ShortText.
- Entities
Field components:
- An array.
- Contains the following components: AuditLogId, CustomData, EntityId, EntityName, Action, Id.
- UserId
Data type: DT_I4
- UserIsDeleted
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/odata/Calendars.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Calendars/Calendars_GetCalendars.
- [Create] action
-
Endpoint URL address:
/odata/Calendars.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Calendars/Calendars_Post.
- [Update] action
-
Endpoint URL address:
/odata/Calendars({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Calendars/Calendars_PutById.
- [Delete] action
-
Endpoint URL address:
/odata/Calendars({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Calendars/Calendars_DeleteById.
- Id
A key field. Data type: DT_I4
- Name
Template: ShortText.
- TimeZoneId
Template: ShortText.
- ExcludedDates
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/odata/CredentialStores.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/CredentialStores/CredentialStores_GetCredentialStores.
- [Create] action
-
Endpoint URL address:
/odata/CredentialStores.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/CredentialStores/CredentialStores_Post.
- [Update] action
-
Endpoint URL address:
/odata/CredentialStores({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/CredentialStores/CredentialStores_PutById.
- [Delete] action
-
Endpoint URL address:
/odata/CredentialStores({{=item.Id}})/UiPath.Server.Configuration.OData.Delete.
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{ key: 0, forceDelete: true }
Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/CredentialStores/CredentialStores_DeleteById.
-
application/json:
- Id
A key field. Data type: DT_I4
- Name
Template: ShortText.
- Type
Template: ShortText.
- AdditionalConfiguration
Template: ShortText.
- Details
Field components:
- Contains the following components: IsReadOnly.
- DefaultCredentialStores
Field components:
- An array.
- Contains the following components: Id, ResourceType.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/odata/Environments.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Environments/Environments_GetEnvironments.
- [Create] action
-
Endpoint URL address:
/odata/Environments.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Environments/Environments_Post.
- [Update] action
-
Endpoint URL address:
/odata/Environments({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Environments/Environments_PutById.
- [Delete] action
-
Endpoint URL address:
/odata/Environments({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Environments/Environments_DeleteById.
- Id
A key field. Data type: DT_I4
- Name
Template: ShortText.
- Description
Template: LongText.
- Robots
Field components:
- An array.
-
Uses template:
Robot.
- Type
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/odata/Folders.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Folders/Folders_GetFolders.
- [Create] action
-
Endpoint URL address:
/odata/Folders.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Folders/Folders_Post.
- [Update] action
-
Endpoint URL address:
/odata/Folders({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Folders/Folders_PutById.
- [Delete] action
-
Endpoint URL address:
/odata/Folders({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Folders/Folders_DeleteById.
- Id
A key field. Data type: DT_I4
- DisplayName
Template: ShortText.
- FullyQualifiedName
Template: ShortText.
- Description
Template: LongText.
- ProvisionType
Template: ShortText.
- PermissionModel
Template: ShortText.
- ParentId
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/odata/HostLicenses.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/HostLicenses/HostLicenses_GetHostLicenses.
- [Delete] action
-
Endpoint URL address:
/odata/HostLicenses({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/HostLicenses/HostLicenses_DeleteById.
- Id
A key field. Data type: DT_I4
- TenantsCount
Data type: DT_I4
- ExpireDate
Data type: DT_I4
- GracePeriodEndDate
Data type: DT_I4
- GracePeriod
Data type: DT_I4
- Allowed
Field components:
- Contains the following components: Unattended, Attended, NonProduction, Development, StudioX.
- Used
Field components:
- Contains the following components: Unattended, Attended, NonProduction, Development, StudioX.
- AttendedConcurrent
Data type: DT_BOOL
- DevelopmentConcurrent
Data type: DT_BOOL
- StudioXConcurrent
Data type: DT_BOOL
- LicensedFeatures
Template: LongText. A composite field.
- IsRegistered
Data type: DT_BOOL
- IsExpired
Data type: DT_BOOL
- CreationTime
Template: DateTime.
- Code
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/odata/Jobs.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Jobs/Jobs_GetJobs.
The resource includes the fields from the Job template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/odata/JobTriggers.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/JobTriggers/JobTriggers_GetJobTriggers.
- Id
A key field. Data type: DT_I4
- JobId
Data type: DT_I4
- TriggerType
Template: ShortText.
- Status
Template: ShortText.
- ItemId
Data type: DT_I4
- Timer
Template: ShortText.
- TriggerMessage
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/odata/Libraries.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Libraries/Libraries_GetLibraries.
- [Delete] action
-
Endpoint URL address:
/odata/Libraries({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Libraries/Libraries_DeleteById.
- Id
A key field. Template: Id.
- Title
Template: ShortText.
- Version
Template: ShortText.
- Key
Template: ShortText.
- Description
Template: LongText.
- Published
Template: ShortText.
- IsLatestVersion
Data type: DT_BOOL
- OldVersion
Template: ShortText.
- ReleaseNotes
Template: ShortText.
- Authors
Template: ShortText.
- ProjectType
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/odata/Machines.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Machines/Machines_GetMachines.
- [Create] action
-
Endpoint URL address:
/odata/Machines.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Machines/Machines_Post.
- [Update] action
-
Endpoint URL address:
/odata/Machines({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Machines/Machines_PutById.
- [Delete] action
-
Endpoint URL address:
/odata/Machines({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Machines/Machines_DeleteById.
- Id
A key field. Data type: DT_I4
- LicenseKey
Template: ShortText.
- Name
Template: ShortText.
- Description
Template: LongText.
- Type
Template: ShortText.
- NonProductionSlots
Data type: DT_I4
- UnattendedSlots
Data type: DT_I4
- RobotVersions
Field components:
- An array.
- Contains the following components: Count, Version, MachineId.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/odata/MessageTemplates.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/MessageTemplates/MessageTemplates_GetMessageTemplates.
- Id
A key field. Template: Id.
- Name
Template: ShortText.
- Value
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/odata/Permissions.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Permissions/Permissions_GetPermissions.
The resource includes the fields from the Permission template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/odata/Processes.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Processes/Processes_GetProcesses.
- [Delete] action
-
Endpoint URL address:
/odata/Processes({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Processes/Processes_DeleteById.
- Id
A key field. Template: Id.
- IsActive
Data type: DT_BOOL
- Arguments
Field components:
-
Uses template:
ShortText. - Contains the following components: Input, Output.
-
Uses template:
- SupportsMultipleEntryPoints
Data type: DT_BOOL
- EntryPoints
Field components:
- An array.
- Contains the following components: Id, UniqueId, Path, InputArguments, OutputArguments.
- Title
Template: ShortText.
- Version
Template: ShortText.
- Key
Template: ShortText.
- Description
Template: LongText.
- Published
Template: ShortText.
- IsLatestVersion
Data type: DT_BOOL
- OldVersion
Template: ShortText.
- ReleaseNotes
Template: ShortText.
- Authors
Template: ShortText.
- ProjectType
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/odata/ProcessSchedules.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/ProcessSchedules/ProcessSchedules_GetProcessSchedules.
- [Create] action
-
Endpoint URL address:
/odata/ProcessSchedules.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/ProcessSchedules/ProcessSchedules_Post.
- [Update] action
-
Endpoint URL address:
/odata/ProcessSchedules({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/ProcessSchedules/ProcessSchedules_PutById.
- [Delete] action
-
Endpoint URL address:
/odata/ProcessSchedules({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/ProcessSchedules/ProcessSchedules_DeleteById.
- Id
A key field. Data type: DT_I4
- Enabled
Data type: DT_BOOL
- Name
Template: ShortText.
- ReleaseId
Data type: DT_I4
- ReleaseKey
Template: ShortText.
- ReleaseName
Template: ShortText.
- PackageName
Template: ShortText.
- EnvironmentName
Template: ShortText.
- EnvironmentId
Template: ShortText.
- StartProcessCron
Template: ShortText.
- StartProcessCronDetails
Template: ShortText.
- StartProcessCronSummary
Template: ShortText.
- StartProcessNextOccurrence
Template: ShortText.
- StartStrategy
Data type: DT_I4
- ExecutorRobots
Field components:
- An array.
- Contains the following components: MachineName, Name, Description, Id.
- StopProcessExpression
Template: ShortText.
- StopStrategy
Template: ShortText.
- ExternalJobKey
Template: ShortText.
- TimeZoneId
Template: ShortText.
- TimeZoneIana
Template: ShortText.
- UseCalendar
Data type: DT_BOOL
- CalendarId
Data type: DT_I4
- CalendarName
Template: ShortText.
- StopProcessDate
Template: ShortText.
- InputArguments
Template: ShortText.
- QueueDefinitionId
Data type: DT_I4
- QueueDefinitionName
Template: ShortText.
- ItemsActivationThreshold
Data type: DT_I4
- ItemsPerJobActivationTarget
Data type: DT_I4
- MaxJobsForActivation
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/odata/QueueDefinitions.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/QueueDefinitions/QueueDefinitions_GetQueueDefinitions.
- [Create] action
-
Endpoint URL address:
/odata/QueueDefinitions.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/QueueDefinitions/QueueDefinitions_Post.
- [Update] action
-
Endpoint URL address:
/odata/QueueDefinitions({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/QueueDefinitions/QueueDefinitions_PutById.
- [Delete] action
-
Endpoint URL address:
/odata/QueueDefinitions({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/QueueDefinitions/QueueDefinitions_DeleteById.
The resource includes the fields from the QueueDef template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/odata/QueueItemComments.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/QueueItemComments/QueueItemComments_GetQueueItemComments.
- [Create] action
-
Endpoint URL address:
/odata/QueueItemComments.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/QueueItemComments/QueueItemComments_Post.
- [Update] action
-
Endpoint URL address:
/odata/QueueItemComments({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/QueueItemComments/QueueItemComments_PutById.
- [Delete] action
-
Endpoint URL address:
/odata/QueueItemComments({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/QueueItemComments/QueueItemComments_DeleteById.
- Id
A key field. Data type: DT_I4
- Text
Template: ShortText.
- QueueItemId
Data type: DT_I4
- CreationTime
Template: DateTime.
- UserId
Data type: DT_I4
- UserName
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/odata/QueueItems.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/QueueItems/QueueItems_GetQueueItems.
- [Update] action
-
Endpoint URL address:
/odata/QueueItems({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/QueueItems/QueueItems_PutById.
- [Delete] action
-
Endpoint URL address:
/odata/QueueItems({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/QueueItems/QueueItems_DeleteById.
- Id
A key field. Data type: DT_I4
- QueueDefinitionId
Data type: DT_I4
- QueueDefinition
Template: QueueDef.
- ProcessingException
Field components:
-
Uses template:
ShortText. - Contains the following components: Reason, Details, Type, AssociatedImageFilePath, CreationTime.
-
Uses template:
- SpecificContent
Template: LongText. A composite field.
- Output
Template: LongText. A composite field.
- OutputData
Template: ShortText.
- Analytics
Template: LongText. A composite field.
- AnalyticsData
Template: ShortText.
- Status
Template: ShortText.
- ReviewStatus
Template: ShortText.
- ReviewerUserId
Data type: DT_I4
- ReviewerUser
Template: User.
- Key
Template: ShortText.
- Reference
Template: ShortText.
- ProcessingExceptionType
Template: ShortText.
- DueDate
Template: ShortText.
- RiskSlaDate
Template: ShortText.
- Priority
Template: ShortText.
- Robot
Template: Robot.
- DeferDate
Template: ShortText.
- StartProcessing
Template: ShortText.
- EndProcessing
Template: ShortText.
- SecondsInPreviousAttempts
Data type: DT_I4
- AncestorId
Data type: DT_I4
- RetryNumber
Data type: DT_I4
- SpecificData
Template: ShortText.
- CreationTime
Template: DateTime.
- Progress
Template: ShortText.
- RowVersion
Template: ShortText.
- Events
A read-only field. Field components:
- An array.
- Contains the following components: Id, QueueItemId, Timestamp, Action, Data, UserId, UserName, Status, ReviewStatus, ReviewerUserId, ReviewerUserName.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/odata/Releases.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Releases/Releases_GetReleases.
- [Create] action
-
Endpoint URL address:
/odata/Releases.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Releases/Releases_Post.
- [Update] action
-
Endpoint URL address:
/odata/Releases({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Releases/Releases_PutById.
- [Delete] action
-
Endpoint URL address:
/odata/Releases({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Releases/Releases_DeleteById.
The resource includes the fields from the Release template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/odata/Robots.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Robots/Robots_GetRobots.
- [Create] action
-
Endpoint URL address:
/odata/Robots.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Robots/Robots_Post.
- [Update] action
-
Endpoint URL address:
/odata/Robots({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Robots/Robots_PutById.
- [Delete] action
-
Endpoint URL address:
/odata/Robots({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Robots/Robots_DeleteById.
The resource includes the fields from the Robot template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/odata/Roles.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Roles/Roles_GetRoles.
- [Create] action
-
Endpoint URL address:
/odata/Roles.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Roles/Roles_Post.
- [Update] action
-
Endpoint URL address:
/odata/Roles({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Roles/Roles_PutById.
- [Delete] action
-
Endpoint URL address:
/odata/Roles({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Roles/Roles_DeleteById.
- Id
A key field. Data type: DT_I4
- Name
Template: ShortText.
- DisplayName
Template: ShortText.
- Groups
Template: ShortText.
- IsStatic
Data type: DT_BOOL
- IsEditable
Data type: DT_BOOL
- Permissions
Field components:
- An array.
-
Uses template:
Permission.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/odata/Sessions.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Sessions/Sessions_GetSessions.
- Id
A key field. Data type: DT_I4
- Robot
Template: Robot.
- HostMachineName
Template: ShortText.
- MachineId
Data type: DT_I4
- MachineName
Template: ShortText.
- State
Template: ShortText.
- Job
Template: Job.
- ReportingTime
Template: DateTime.
- Info
Template: ShortText.
- IsUnresponsive
Data type: DT_BOOL
- LicenseErrorCode
Template: ShortText.
- OrganizationUnitId
Data type: DT_I4
- FolderName
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/odata/Settings.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Settings/Settings_GetSettings.
- [Update] action
-
Endpoint URL address:
/odata/Settings({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Settings/Settings_PutById.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/odata/TaskCatalogs.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/TaskCatalogs/TaskCatalogs_GetTaskCatalogs.
- [Create] action
-
Endpoint URL address:
/odata/TaskCatalogs/UiPath.Server.Configuration.OData.CreateTaskCatalog.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/TaskCatalogs/TaskCatalogs_CreateTaskCatalog.
- [Update] action
-
Endpoint URL address:
/odata/TaskCatalogs({{=item.Id}})/UiPath.Server.Configuration.OData.UpdateTaskCatalog.
The action uses POST method.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/TaskCatalogs/TaskCatalogs_UpdateTaskCatalogById.
- Id
A key field. Data type: DT_I4
- Name
Template: ShortText.
- Description
Template: LongText.
- LastModificationTime
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/odata/Tasks.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Tasks/Tasks_GetTasks.
- Id
A key field. Data type: DT_I4
- Title
Template: ShortText.
- Type
Template: ShortText.
- Priority
Template: ShortText.
- Status
Template: ShortText.
- AssignedToUser
Field components:
-
Uses template:
ShortText. - Contains the following components: name, surname, userName, emailAddress, id.
-
Uses template:
- CreationTime
Template: DateTime.
- TaskCatalogName
Template: ShortText.
- OrganizationUnitId
Data type: DT_I4
- IsCompleted
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/odata/Tenants.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Tenants/Tenants_GetTenants.
- [Create] action
-
Endpoint URL address:
/odata/Tenants.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Tenants/Tenants_Post.
- [Update] action
-
Endpoint URL address:
/odata/Tenants({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Tenants/Tenants_PatchById.
- [Delete] action
-
Endpoint URL address:
/odata/Tenants({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Tenants/Tenants_DeleteById.
- Id
A key field. Data type: DT_I4
- Name
Template: ShortText.
- Key
Template: ShortText.
- DisplayName
Template: ShortText.
- AdminEmailAddress
Template: ShortText.
- AdminName
Template: ShortText.
- AdminSurname
Template: ShortText.
- AdminPassword
Template: ShortText.
- LastLoginTime
Template: DateTime.
- IsActive
Data type: DT_BOOL
- AcceptedDomainsList
Template: LongText. A composite field.
- HasConnectionString
Data type: DT_BOOL
- ConnectionString
Template: ShortText.
- License
Field components:
-
Uses template:
ShortText. - Contains the following components: HostLicenseId, CreationTime, Code, Allowed, Id.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/odata/Users.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Users/Users_GetUsers.
- [Create] action
-
Endpoint URL address:
/odata/Users.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Users/Users_Post.
- [Update] action
-
Endpoint URL address:
/odata/Users({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Users/Users_PutById.
- [Delete] action
-
Endpoint URL address:
/odata/Users({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Users/Users_DeleteById.
The resource includes the fields from the User template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/odata/Webhooks.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Webhooks/Webhooks_GetWebhooks.
- [Create] action
-
Endpoint URL address:
/odata/Webhooks.Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Webhooks/Webhooks_Post.
- [Update] action
-
Endpoint URL address:
/odata/Webhooks({{=item.Id}}).Documentation: https://platform.uipath.com/cozyroc/COZYROCDefa9mtd251193/swagger/ui/index#!/Webhooks/Webhooks_PutById.
- [Delete] action
-
Endpoint URL address:
/odata/Webhooks({{=item.Id}}).Documentation: PUT /odata/Webhooks({Id}).
- Id
A key field. Data type: DT_I4
- Url
Template: ShortText.
- Enabled
Data type: DT_BOOL
- Secret
Template: ShortText.
- SubscribeToAllEvents
Data type: DT_BOOL
- AllowInsecureSsl
Data type: DT_BOOL
- Events
Field components:
- An array.
- [Read] action
-
The result is extracted from:{{=response.value}}.
The result is paginated.The following request parameters will be automatically processed:
-
$top:
{{=parameters.batchSize}} -
$skiptoken:
{{=parameters.iterator}} -
_includeUserParameters:
{{=parameters}}
-
$top:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Delete] action
-
The action uses DELETE method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Id
Data type: DT_GUID
- Environment
Field components:
-
Uses template:
ShortText. - Contains the following components: Id, Name, Description, Robots, Type.
-
Uses template:
- Robot
Field components:
-
Uses template:
ShortText. - Contains the following components: Id, LicenseKey, MachineName, MachineId, Name, Username, ExternalName, Description, Version, Type, HostingType, ProvisionType, Password, CredentialStoreId, UserId, CredentialType, Environments, RobotEnvironments, ExecutionSettings, IsExternalLicensed.
-
Uses template:
- Version
Field components:
-
Uses template:
ShortText. - Contains the following components: Id, ReleaseId, VersionNumber, CreationTime, ReleaseName.
-
Uses template:
- Release
Field components:
-
Uses template:
ShortText. - Contains the following components: Id, Key, ProcessKey, ProcessVersion, IsLatestVersion, IsProcessDeleted, Description, Name, EnvironmentId, EnvironmentName, Environment, InputArguments, CurrentVersion, ReleaseVersions, Arguments, ProcessSettings, AutoUpdate.
-
Uses template:
- QueueDef
Field components:
-
Uses template:
ShortText. - Contains the following components: Id, Name, Description, MaxNumberOfRetries, AcceptAutomaticallyRetry, EnforceUniqueReference, SpecificDataJsonSchema, OutputDataJsonSchema, AnalyticsDataJsonSchema, CreationTime, ProcessScheduleId, SlaInMinutes, RiskSlaInMinutes, ReleaseId.
-
Uses template:
- User
Field components:
-
Uses template:
ShortText. - Contains the following components: Id, Name, Surname, UserName, Domain, FullName, EmailAddress, IsEmailConfirmed, LastLoginTime, IsActive, CreationTime, AuthenticationSource, Password, IsExternalLicensed, UserRoles, RolesList, LoginProviders, OrganizationUnits, TenantId, TenancyName, TenantDisplayName, TenantKey, Type, ProvisionType, LicenseType, RobotProvision, NotificationSubscription, Key, MayHaveUserSession, MayHaveRobotSession, BypassBasicAuthRestriction.
-
Uses template:
- Permission
Field components:
-
Uses template:
ShortText. - Contains the following components: Id, Name, IsGranted, RoleId, Scope.
-
Uses template:
- Job
Field components:
-
Uses template:
ShortText. - Contains the following components: Id, Key, StartTime, EndTime, State, Robot, Release, Source, SourceType, BatchExecutionKey, Info, CreationTime, StartingScheduleId, ReleaseName, Type, InputArguments, OutputArguments, HostMachineName, HasMediaRecorded, PersistenceId, ResumeVersion, StopStrategy, ReleaseVersionId, EntryPointPath.
-
Uses template:
Knowledge Base
What's New
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.