Orchestrator
2021.10
false
  • Getting Started
    • Read Me
    • About OData and References
    • Orchestrator URL
    • API References
    • Logical Resources and Metadata
    • Available Operations
    • Enumerated Types
    • Authenticating
    • Building API Requests
    • Using OAuth for External Apps
    • Permissions Per Endpoint
    • Response Codes
    • Health Check Endpoints
  • The Swagger Definition
  • Examples using the Orchestrator API
  • Platform Management APIs
Banner background image
Orchestrator API Guide
Last updated Apr 19, 2024

Logical Resources and Metadata

The following logical resources in Orchestrator can be manipulated using API methods:

  • Account
  • Alerts
  • Assets
  • AuditLogs
  • Environments
  • Folders
  • Jobs
  • Logs
  • Permissions
  • Processes
  • ProcessSchedules
  • QueueDefinitions
  • QueueItemComments
  • QueueItemEvents
  • QueueItems
  • QueueProcessingRecords
  • Queues
  • Releases
  • RobotLogs
  • Robots
  • RobotsService
  • Roles
  • Sessions
  • Settings
  • Stats
  • Status
  • Storage Buckets
  • Tenants
  • UserLoginAttempts
  • Users

The Orchestrator API provides custom methods for querying stats about various entities registered in Orchestrator. Each logical resource is an OData entity. All entities (such as Robot, Process, Queue) have properties, relationships, and operations.



Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.