Skip to content

Version2

Quentin Brandon edited this page Apr 4, 2018 · 1 revision

API Version 2 helpers

orchestratorInstance.v2

API

v2.api

Account

// POST /api/Account
v2.api.postAccount(data, callback)

Logs

// POST /api/logs
v2.api.postLogs(data, callback)
// POST /api/Logs/SubmitLogs
v2.api.postSubmitLogs(data, callback)

RobotsService

// POST /api/RobotsService/SubmitHeartbeat
v2.api.postSubmitHeartbeat(data, callback)
// POST /api/RobotsService/SubmitJobState
v2.api.postSubmitJobState(data, callback)
// GET /api/RobotsService/GetRobotMappings
v2.api.getRobotMapping(query, callback)
// GET /api/RobotsService/GetConnectionData
v2.api.getConnectionData(query, callback)
// POST /api/RobotsService/AcquireLicense
v2.api.postAcquireLicense(data, callback)
// POST /api/RobotsService/ReleaseLicense
v2.api.postReleaseLicense(data, callback)
// GET ReleaseLicense
v2.api.getRobotsService(query, callback)

Stats

// GET /api/Stats/GetCountStats
v2.api.getCountState(query, callback)
// GET /api/Stats/GetSessionsStats
v2.api.getSessionStats(query, callback)
// GET /api/Stats/GetJobsStats
v2.api.getJobsStats(query, callback)

Status

// GET /api/Status
v2.api.getStatus(query, callback)

ODATA

v2.odata

Alerts

// GET /odata/Alerts
v2.odata.getAlerts(query, callback)
// GET /odata/Alerts/UiPath.Server.Configuration.OData.GetUnreadCount()
v2.odata.getUnreadAlertCount(query, callback)
// POST /odata/Alerts/UiPath.Server.Configuration.OData.MarkAsRead
v2.odata.postMarkAlertAsRead(data, callback)
// POST /odata/Alerts/UiPath.Server.Configuration.OData.RaiseProcessAlert
v2.odata.postRaiseProcessAlert(data, callback)

Assets

// GET /odata/Assets
v2.odata.getAssets(query, callback)
// PUT /odata/Assets(<id>)
v2.odata.putAsset(id, data, callback)
// DELETE /odata/Assets(<id>)
v2.odata.deleteAsset(id, callback)
// GET /odata/Assets/UiPath.Server.Configuration.OData.GetRobotAsset(robotId='<robotId>',assetName='<assetName>')
v2.odata.getRobotAsset(robotId, assetName, query, callback)

AuditLogs

// GET /odata/AuditLogs
v2.odata.getAuditLogs(query, callback)
// GET /odata/AuditLogs/UiPath.Server.Configuration.OData.Reports()
v2.odata.getAuditReports(query, callback)
// GET /odata/AuditLogs/UiPath.Server.Configuration.OData.GetAuditLogDetails(auditLogId=<auditLogId>)
v2.odata.getAuditLogDetails(auditLogId, query, callback)

Environments

// GET /odata/Environments
v2.odata.getEnvironments(query, callback)
// GET /odata/Environments(<id>)
v2.odata.getEnvironment(id, query, callback)
// PUT /odata/Environments(<id>)
v2.odata.putEnvironment(id, data, callback)
// DELETE /odata/Environments(<id>)
v2.odata.deleteEnvironment(id, data, callback)
// GET /odata/Environments/UiPath.Server.Configuration.OData.GetRobotsForEnvironment(key=<key>)
v2.odata.getRobotsForEnvironment(key, query, callback)
// GET /odata/Environments/UiPath.Server.Configuration.OData.GetRobotIdsForEnvironment(key=<key>)
v2.odata.getRobotIdsForEnvironment(key, query, callback)
// POST /odata/Environments(<id>)/UiPath.Server.Configuration.OData.AddRobot
v2.odata.postEnvironmentAddRobot(id, data, callback)
// POST /odata/Environments(<id>)/UiPath.Server.Configuration.OData.RemoveRobot
v2.odata.postEnvironmentRemoveRobot(id, data, callback)
// POST /odata/Environments(<id>)/UiPath.Server.Configuration.OData.SetRobots
v2.odata.postEnvironmentSetRobots(id, data, callback)

Jobs

// GET /odata/Jobs
v2.odata.getJobs(query, callback)
// GET /odata/Jobs(<id>)
v2.odata.getJob(id, query, callback)
// PUT /odata/Jobs(<id>)
v2.odata.putJob(id, data, callback)
// POST /odata/Jobs(<id>)/UiPath.Server.Configuration.OData.StopJob
v2.odata.postStopJob(id, data, callback)
// POST /odata/Jobs/UiPath.Server.Configuration.OData.StartJobs
v2.odata.postStartJobs(data, callback)

Permissions

// GET /odata/Permissions
v2.odata.getPermissions(query, callback)

Processes

// GET /odata/Processes
v2.odata.getProcesses(query, callback)
// POST /odata/Processes/UiPath.Server.Configuration.OData.UploadPackage
v2.odata.postUploadPackage(data, callback)
// DELETE /odata/Processes('<id>')
v2.odata.deleteProcesse(id, callback)
// GET /odata/Processes/UiPath.Server.Configuration.OData.GetProcessVersions(processId='<processId>')
v2.odata.getProcessVersions(processId, query, callback)

ProcessSchedules

// GET /odata/ProcessSchedules
v2.odata.getProcessSchedules(query, callback)
// GET /odata/ProcessSchedules(<id>)
v2.odata.getProcessSchedule(id, query, callback)
// PUT /odata/ProcessSchedules(<id>)
v2.odata.putProcessSchedule(id, data, callback)
// DELETE /odata/ProcessSchedules(<id>)
v2.odata.deleteProcessSchedule(id, callback)
// POST /odata/ProcessSchedules/UiPath.Server.Configuration.OData.SetEnabled
v2.odata.postSetProcessScheduleEnabled(data, callback)
// GET /odata/ProcessSchedules/UiPath.Server.Configuration.OData.GetRobotIdsForSchedule(key=<key>)
v2.odata.getRobotIdsForSchedule(key, query, callback)

QueueDefinitions

// GET /odata/QueueDefinitions
v2.odata.getQueueDefinitions(query, callback)
// GET /odata/QueueDefinitions(<id>)
v2.odata.getQueueDefinition(id, query, callback)
// PUT /odata/QueueDefinitions(<id>)
v2.odata.putQueueDefinition(id, data, callback)
// DELETE /odata/QueueDefinitions(<id>)
v2.odata.deleteQueueDefinition(id, callback)
// GET /odata/QueueDefinitions(<id>)/UiPathODataSvc.Reports()
v2.odata.getQueueDefinitionReports(id, query, callback)

QueueItemComments

// GET /odata/QueueItemComments
v2.odata.getQueueItemComments(query, callback)
// GET /odata/QueueItemComments(<id>)
v2.odata.getQueueItemComment(id, query, callback)
// PUT /odata/QueueItemComments(<id>)
v2.odata.putQueueItemComment(id, data, callback)
// DELETE /odata/QueueItemComments(<id>)
v2.odata.deleteQueueItemComment(id, callback)
// GET /odata/QueueItemComments/UiPath.Server.Configuration.OData.GetQueueItemCommentsHistory(queueItemId=<queueItemId>)
v2.odata.getQueueItemCommentsHistory(queueItemId, query, callback)

QueueItemEvents

// GET /odata/QueueItemEvents
v2.odata.getQueueItemEvents(query, callback)
// GET /odata/QueueItemEvents(<id>)
v2.odata.getQueueItemEvent(id, query, callback)
// GET /odata/QueueItemEventsQueueItemEvents/UiPath.Server.Configuration.OData.GetQueueItemEventsHistory(queueItemId=<queueItemId>)
v2.odata.getQueueItemEventsHistory(queueItemId, query, callback)

QueueItems

// GET /odata/QueueItems
v2.odata.getQueueItems(query, callback)
// GET /odata/QueueItems(<id>)
v2.odata.getQueueItem(id, query, callback)
// PUT /odata/QueueItems(<id>)
v2.odata.putQueueItem(id, data, callback)
// DELETE /odata/QueueItems(<id>)
v2.odata.deleteQueueItem(id, callback)
// PATCH /odata/QueueItems(<id>)
v2.odata.patchQueueItem(id, data, callback)
// POST /odata/QueueItems/UiPathODataSvc.SetItemReviewStatus
v2.odata.postSetQueueItemReviewStatus(data, callback)
// POST /odata/QueueItems/UiPathODataSvc.DeleteBulk
v2.odata.postDeleteBulkQueueItems(data, callback)
// POST /odata/QueueItems/UiPathODataSvc.SetItemReviewer
v2.odata.postSetQueueItemReviewer(data, callback)
// POST /odata/QueueItems/UiPathODataSvc.UnsetItemReviewer
v2.odata.postUnsetQueueItemReviewer(data, callback)
// GET /odata/QueueItems/UiPath.Server.Configuration.OData.GetReviewers()
v2.odata.getQueueItemsReviewers(query, callback)
// GET /odata/QueueItems(<id>)/UiPathODataSvc.GetItemProcessingHistory()
v2.odata.getItemProcessingHistory(id, query, callback)
// POST /odata/QueueItems(<id>)/UiPathODataSvc.SetTransactionProgress
v2.odata.postSetTransactionProgress(id, data, callback)

QueueProcessingRecords

// GET /odata/QueueProcessingRecords
v2.odata.getQueueProcessingRecords(query, callback)
// GET /odata/QueueProcessingRecords(<id>)
v2.odata.getQueueProcessingRecord(id, query, callback)
// DELETE /odata/QueueProcessingRecords(<id>)
v2.odata.deleteQueueProcessingRecord(id, callback)
// GET /odata/QueueProcessingRecords/UiPathODataSvc.RetrieveQueuesProcessingStatus()
v2.odata.getRetrieveQueuesProcessingStatus(query, callback)
// GET /odata//UiPathODataSvc.RetrieveLastDaysProcessingRecords(daysNo=<daysNo>,queueDefinitionId=<queueDefinitionId>)
v2.odata.getLastDaysProcessingRecords(queueDefinitionId, daysNo, query, callback)

Queues

// GET /odata/Queues
v2.odata.getQueues(query, callback)
// GET /odata/Queues(<id>)
v2.odata.getQueue(id, query, callback)
// POST /odata/Queues/UiPathODataSvc.StartTransaction
v2.odata.postStartTransaction(data, callback)
// POST /odata/Queues/UiPathODataSvc.AddQueueItem
v2.odata.postAddQueueItem(data, callback)
// POST /odata/Queues(<id>)/UiPathODataSvc.SetTransactionResult
v2.odata.postSetTransactionResult(id, data, callback)

Releases

// GET /odata/Releases
v2.odata.getReleases(query, callback)
// GET /odata/Releases(<id>)
v2.odata.getRelease(id, query, callback)
// PUT /odata/Releases(<id>)
v2.odata.putRelease(id, data, callback)
// DELETE /odata/Releases(<id>)
v2.odata.deleteRelease(id, callback)
// POST /odata/Releases(<id>)/UiPath.Server.Configuration.OData.UpdateToSpecificPackageVersion
v2.odata.postUpdateReleaseToSpecificPackageVersion(id, data, callback)
// POST /odata/Releases(<id>)/UiPath.Server.Configuration.OData.UpdateToLatestPackageVersion
v2.odata.postUpdateReleaseToLatestPackageVersion(id, data, callback)
// POST /odata/Releases(<id>)/UiPath.Server.Configuration.OData.RollbackToPreviousReleaseVersion
v2.odata.postRollbackToPreviousReleaseVersion(id, data, callback)

RobotLogs

// GET /odata/RobotLogs
v2.odata.getRobotLogs(query, callback)
// GET /odata/RobotLogs/UiPath.Server.Configuration.OData.Reports()
v2.odata.getRobotLogsReports(query, callback)

Robots

// GET /odata/Robots
v2.odata.getRobots(query, callback)
// GET /odata/Robots(<id>)
v2.odata.getRobot(id, query, callback)
// PUT /odata/Robots(<id>)
v2.odata.putRobot(id, data, callback)
// DELETE /odata/Robots(<id>)
v2.odata.deleteRobot(id, callback)
// GET /odata/Robots/UiPath.Server.Configuration.OData.GetMachineNameToLicenseKeyMappings()
v2.odata.getMachineNameToLicenseKeyMappings(query, callback)

Roles

// GET /odata/Roles
v2.odata.getRoles(query, callback)
// PUT /odata/Roles(<id>)
v2.odata.putRole(id, data, callback)
// DELETE /odata/Roles(<id>)
v2.odata.deleteRole(id, callback)
// GET /odata/Roles/UiPath.Server.Configuration.OData.GetUsersForRole(key=<key>)
v2.odata.getUsersForRole(key, query, callback)
// GET /odata/Roles/UiPath.Server.Configuration.OData.GetUserIdsForRole(key=<key>)
v2.odata.getUserIdsForRole(key, query, callback)
// POST /odata/Roles(<id>)/UiPath.Server.Configuration.OData.SetUsers
v2.odata.postSetRoleUsers(id, data, callback)

Sessions

// GET /odata/Sessions
v2.odata.getSessions(query, callback)

Settings

// GET /odata/Settings
v2.odata.getSettings(query, callback)
// GET /odata/Settings(idOrKey)
v2.odata.getSetting(idOrKey, query, callback)
// PUT /odata/Settings(id)
v2.odata.putSetting(id, data, callback)
// GET /odata/Settings/UiPath.Server.Configuration.OData.GetServicesSettings()
v2.odata.getServicesSettings(query, callback)
// GET /odata/Settings/UiPath.Server.Configuration.OData.GetWebSettings()
v2.odata.getWebSettings(query, callback)
// GET /odata/Settings/UiPath.Server.Configuration.OData.GetAuthenticationSettings()
v2.odata.getAuthenticationSettings(query, callback)
// GET /odata/Settings/UiPath.Server.Configuration.OData.GetConnectionString()
v2.odata.getConnectionString(query, callback)
// GET /odata/Settings/UiPath.Server.Configuration.OData.GetLicense()
v2.odata.getLicense(query, callback)
// POST /odata/Settings/UiPath.Server.Configuration.OData.UploadLicense
v2.odata.postUploadLicense(data, callback)
// GET /odata/Settings/UiPath.Server.Configuration.OData.GetTimezones()
v2.odata.getTimezones(query, callback)
// POST /odata/Settings/UiPath.Server.Configuration.OData.UpdateBulk
v2.odata.postUpdateBulkSettings(data, callback)
// GET /odata/Settings/UiPath.Server.Configuration.OData.GetExecutionSettingsConfiguration(scope=<scope>)
v2.odata.getExecutionSettingsConfiguration(scope, query, callback)

Tenants

// GET /odata/Tenants
v2.odata.getTenants(query, callback)
// GET /odata/Tenants(<id>)
v2.odata.getTenant(id, query, callback)
// PUT /odata/Tenants(<id>)
v2.odata.putTenant(id, data, callback)
// DELETE /odata/Tenants(<id>)
v2.odata.deleteTenant(id, callback)
// POST /odata/Tenants/UiPath.Server.Configuration.OData.SetActive
v2.odata.postSetActiveTenant(data, callback)

UserLoginAttempts

// GET /odata/UserLoginAttempts(<id>)
v2.odata.getUserLoginAttempts(id, query, callback)

Users

// GET /odata/Users
v2.odata.getUsers(query, callback)
// GET /odata/Users(<id>)
v2.odata.getUser(id, query, callback)
// PUT /odata/Users(<id>)
v2.odata.putUser(id, data, callback)
// DELETE /odata/Users(<id>)
v2.odata.deleteUser(id, callback)
// PATCH /odata/Users(<id>)
v2.odata.patchUser(id, data, callback)
// GET /odata/Users/UiPath.Server.Configuration.OData.GetCurrentPermissions()
v2.odata.getCurrentUserPermissions(query, callback)
// GET /odata/Users/UiPath.Server.Configuration.OData.GetCurrentUser()
v2.odata.getCurrentUser(query, callback)
// POST /odata/Users/UiPath.Server.Configuration.OData.ImportUsers
v2.odata.postImportUsers(data, callback)
// POST /odata/Users(<id>)/UiPath.Server.Configuration.OData.ToggleRole
v2.odata.postToggleUserRole(id, data, callback)
// POST /odata/Users(<id>)/UiPath.Server.Configuration.OData.ChangePassword
v2.odata.postChangeUserPassword(id, data, callback)
// POST /odata/Users(<id>)/UiPath.Server.Configuration.OData.SetActive
v2.odata.postSetUserActive(id, data, callback)