Created
November 4, 2025 18:18
-
-
Save cprima/8a6cda72c2386f883858e4fccfe08ced to your computer and use it in GitHub Desktop.
openapi.json
This file has been truncated, but you can view the full file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "swagger": "2.0", | |
| "info": { | |
| "title": "UiPath.WebApi 20.0", | |
| "description": "Orchestrator API", | |
| "version": "20.0" | |
| }, | |
| "host": "cloud.uipath.com", | |
| "basePath": "/rpapub/playground/orchestrator_/", | |
| "schemes": [ | |
| "https" | |
| ], | |
| "paths": { | |
| "/api/Buckets/{id}/ListFiles": { | |
| "get": { | |
| "tags": [ | |
| "Buckets" | |
| ], | |
| "summary": "Gets all files in a directory and subdirectories, with continuation token support.", | |
| "description": "OAuth required scopes: OR.Administration or OR.Administration.Read.\n\nRequired permissions: Buckets.View and BlobFiles.View.", | |
| "operationId": "Buckets_ListFilesById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "description": "The Bucket ID", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "prefix", | |
| "description": "The path prefix", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "takeHint", | |
| "description": "The minimum number of files to return in the response. The service will attempt to return at least this many files,\r\nbut may return up to twice this number in some cases. The maximum allowed value is 1000. If not specified or set to 0,\r\nthe default value is 500.", | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 0 | |
| }, | |
| { | |
| "in": "query", | |
| "name": "continuationToken", | |
| "description": "A token indicating where to resume listing files. Used for pagination; pass the token from a previous response to\r\nretrieve the next set of results.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "expiryInMinutes", | |
| "description": "The number of minutes before the generated access URL expires, if not provided, the access url will not be returned.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ListBlobItemsResponseDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/DirectoryService/GetDirectoryPermissions": { | |
| "get": { | |
| "tags": [ | |
| "DirectoryService" | |
| ], | |
| "summary": "Gets directory permissions", | |
| "description": "OAuth required scopes: OR.Users or OR.Users.Read.\n\nRequired permissions: Users.View.", | |
| "operationId": "DirectoryService_GetDirectoryPermissions", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "username", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "domain", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DirectoryPermissionDto" | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/DirectoryService/GetDomains": { | |
| "get": { | |
| "tags": [ | |
| "DirectoryService" | |
| ], | |
| "summary": "Gets domains", | |
| "description": "OAuth required scopes: OR.Users or OR.Users.Read.\n\nRequired permissions: (Users.View or Units.Edit or SubFolders.Edit).", | |
| "operationId": "DirectoryService_GetDomains", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DomainDto" | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/DirectoryService/GetDomainUserId": { | |
| "get": { | |
| "tags": [ | |
| "DirectoryService" | |
| ], | |
| "summary": "Gets an orchestrator user Id by searching for the domain user information.", | |
| "description": "OAuth required scopes: OR.Users or OR.Users.Read.\n\nRequired permissions: (Users.View or Units.Edit or SubFolders.Edit).", | |
| "operationId": "DirectoryService_GetDomainUserId", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "domain", | |
| "description": "", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "directoryIdentifier", | |
| "description": "", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "userName", | |
| "description": "", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "userType", | |
| "description": "", | |
| "type": "string", | |
| "enum": [ | |
| "User", | |
| "Robot", | |
| "DirectoryUser", | |
| "DirectoryGroup", | |
| "DirectoryRobot", | |
| "DirectoryExternalApplication" | |
| ], | |
| "x-ms-enum": { | |
| "name": "UserType", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "User", | |
| "Robot", | |
| "DirectoryUser", | |
| "DirectoryGroup", | |
| "DirectoryRobot", | |
| "DirectoryExternalApplication" | |
| ] | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "format": "int64", | |
| "type": "integer" | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "schema": { | |
| "format": "int64", | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/DirectoryService/SearchForUsersAndGroups": { | |
| "get": { | |
| "tags": [ | |
| "DirectoryService" | |
| ], | |
| "summary": "Search users and groups", | |
| "description": "OAuth required scopes: OR.Users or OR.Users.Read.\n\nRequired permissions: (Users.View or Units.Edit or SubFolders.Edit).", | |
| "operationId": "DirectoryService_SearchForUsersAndGroups", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "searchContext", | |
| "description": "", | |
| "type": "string", | |
| "enum": [ | |
| "All", | |
| "Users", | |
| "Groups", | |
| "Robots", | |
| "ExternalApplications" | |
| ], | |
| "x-ms-enum": { | |
| "name": "SearchContext", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "All", | |
| "Users", | |
| "Groups", | |
| "Robots", | |
| "ExternalApplications" | |
| ] | |
| }, | |
| { | |
| "in": "query", | |
| "name": "domain", | |
| "description": "", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "prefix", | |
| "description": "", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/DirectoryObjectDto" | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/Folders/DeleteByKey": { | |
| "delete": { | |
| "tags": [ | |
| "Folders" | |
| ], | |
| "summary": "Deletes a folder. Succeeds only if no entities or user associations\r\nexist in this folder or any of its descendants.", | |
| "description": "OAuth required scopes: OR.Folders or OR.Folders.Write.\n\nRequired permissions: (Units.Delete or SubFolders.Delete - Deletes any folder or only if user has SubFolders.Delete permission on the provided folder).", | |
| "operationId": "Folders_DeleteByKey", | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "key", | |
| "description": "", | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Deleted" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/Folders/GetAllForCurrentUser": { | |
| "get": { | |
| "tags": [ | |
| "Folders" | |
| ], | |
| "summary": "Returns a subset (paginated) of the folders the current user has access to.\r\nThe response will be a list of folders;", | |
| "description": "OAuth required scopes: OR.Folders or OR.Folders.Read.\n\nRequires authentication.", | |
| "operationId": "Folders_GetAllForCurrentUser", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "take", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "skip", | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/PageResultDtoOfCurrentUserFolderDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/Folders/PatchNameDescription": { | |
| "patch": { | |
| "tags": [ | |
| "Folders" | |
| ], | |
| "summary": "Edits a folder.", | |
| "description": "OAuth required scopes: OR.Folders or OR.Folders.Write.\n\nRequired permissions: (Units.Edit or SubFolders.Edit - Edits any folder or edits only if user has SubFolders.Edit permission on the provided folder).", | |
| "operationId": "Folders_PatchNameDescription", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/FolderUpdateNameDescriptionRequest" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "key", | |
| "description": "", | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/FoldersNavigation/GetAllFoldersForCurrentUser": { | |
| "get": { | |
| "tags": [ | |
| "FoldersNavigation" | |
| ], | |
| "summary": "Returns the folders the current user has access to.\r\nThe response will be a list of folders; the hierarchy can be reconstructed\r\nusing the ParentId properties. From the root to the folders the user has\r\nactually been assigned to, the folders will be marked as non-selectable\r\nand only the paths to the assigned-to folders will be included.\r\nFrom the assigned-to folders down to the leaves, the nodes will be marked as\r\nselectable and their children lists fully populated.", | |
| "description": "OAuth authentication is not supported.\n\nRequires authentication.", | |
| "operationId": "FoldersNavigation_GetAllFoldersForCurrentUser", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ExtendedFolderDto" | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/FoldersNavigation/GetAllRolesForUser": { | |
| "get": { | |
| "tags": [ | |
| "FoldersNavigation" | |
| ], | |
| "summary": "Returns a page of the user-folder assignments for the input user, including the roles for each folder.\r\nThe response also includes the folders assigned to the directory groups of the user.\r\nThe distinction between the folders assigned directly to the user and the ones assigned to one of his groups\r\ncan be made via the User field of the response.", | |
| "description": "OAuth authentication is not supported.\n\nRequired permissions: (Units.View - Gets roles from all folders) and (SubFolders.View - Gets roles only from folders where caller has SubFolders.View permission).", | |
| "operationId": "FoldersNavigation_GetAllRolesForUser", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "username", | |
| "description": "User name", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "type", | |
| "description": "", | |
| "type": "string", | |
| "enum": [ | |
| "User", | |
| "Group", | |
| "Machine", | |
| "Robot", | |
| "ExternalApplication" | |
| ], | |
| "x-ms-enum": { | |
| "name": "DirectoryObjectType", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "User", | |
| "Group", | |
| "Machine", | |
| "Robot", | |
| "ExternalApplication" | |
| ] | |
| }, | |
| { | |
| "in": "query", | |
| "name": "skip", | |
| "description": "", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "take", | |
| "description": "", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "searchText", | |
| "description": "", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/UserRoleAssignmentsDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/FoldersNavigation/GetFolderNavigationContextForCurrentUser": { | |
| "get": { | |
| "tags": [ | |
| "FoldersNavigation" | |
| ], | |
| "summary": "Returns a subset (paginated) of direct children for a given folder, which are accessible to the current user.\r\nTo ease a folder tree structure navigation design, the list of ancestors for the given folder is also returned.", | |
| "description": "OAuth authentication is not supported.\n\nRequires authentication.", | |
| "operationId": "FoldersNavigation_GetFolderNavigationContextForCurrentUser", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "skip", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "take", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "folderId", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/FolderNavigationContextDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/FoldersNavigation/GetFoldersForCurrentUser": { | |
| "get": { | |
| "tags": [ | |
| "FoldersNavigation" | |
| ], | |
| "summary": "Returns a filtered subset (paginated) of the folders the current user has access to.", | |
| "description": "OAuth authentication is not supported.\n\nRequires authentication.", | |
| "operationId": "FoldersNavigation_GetFoldersForCurrentUser", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "skip", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "take", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "searchText", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "folderTypes", | |
| "type": "array", | |
| "items": { | |
| "enum": [ | |
| "Standard", | |
| "Personal", | |
| "Virtual", | |
| "Solution", | |
| "DebugSolution" | |
| ], | |
| "type": "string", | |
| "x-ms-enum": { | |
| "name": "FolderType", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "Standard", | |
| "Personal", | |
| "Virtual", | |
| "Solution", | |
| "DebugSolution" | |
| ] | |
| }, | |
| "collectionFormat": "multi" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/PageResultDtoOfPathAwareFolderDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/JobTriggers/DeliverPayload/{inboxId}": { | |
| "post": { | |
| "tags": [ | |
| "JobTriggers" | |
| ], | |
| "summary": "Deliver payload for trigger inboxId.", | |
| "description": "OAuth required scopes: OR.Jobs or OR.Jobs.Write.\n\nRequired permissions: Jobs.Edit.", | |
| "operationId": "JobTriggers_DeliverPayloadByInboxid", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "inboxId", | |
| "description": "", | |
| "required": true, | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "maxLength": 4000 | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "202": { | |
| "description": "Accepted" | |
| }, | |
| "208": { | |
| "description": "Success" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/JobTriggers/GetPayload/{inboxId}": { | |
| "get": { | |
| "tags": [ | |
| "JobTriggers" | |
| ], | |
| "summary": "Get payload for trigger inboxId.", | |
| "operationId": "JobTriggers_GetPayloadByInboxid", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "inboxId", | |
| "description": "", | |
| "required": true, | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": {} | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/Licensing/Acquire": { | |
| "post": { | |
| "tags": [ | |
| "Licensing" | |
| ], | |
| "summary": "Acquire license units", | |
| "description": "OAuth required scopes: OR.Administration or OR.Administration.Write.\n\nRequires authentication.", | |
| "operationId": "Licensing_Acquire", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "schema": { | |
| "$ref": "#/definitions/ConsumptionLicenseDto" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/LicenseResultDto" | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request" | |
| }, | |
| "409": { | |
| "description": "Conflict" | |
| }, | |
| "503": { | |
| "description": "Server Error" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/Licensing/Release": { | |
| "put": { | |
| "tags": [ | |
| "Licensing" | |
| ], | |
| "summary": "Release acquired license units", | |
| "description": "OAuth required scopes: OR.Administration or OR.Administration.Write.\n\nRequires authentication.", | |
| "operationId": "Licensing_Release", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "schema": { | |
| "$ref": "#/definitions/ConsumptionLicenseDto" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/LicenseResultDto" | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request" | |
| }, | |
| "409": { | |
| "description": "Conflict" | |
| }, | |
| "503": { | |
| "description": "Server Error" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/Logs": { | |
| "post": { | |
| "tags": [ | |
| "Logs" | |
| ], | |
| "summary": "Inserts a log entry with a specified message in JSON format.", | |
| "description": "OAuth required scopes: OR.Monitoring or OR.Monitoring.Write.\n\nRequired permissions: (Logs.Create).\n\nExample of jMessage parameter.\r\n \r\n {\r\n \"message\": \"TTT execution started\",\r\n \"level\": \"Information\",\r\n \"timeStamp\": \"2017-01-18T14:46:07.4152893+02:00\",\r\n \"windowsIdentity\": \"DESKTOP-1L50L0P\\\\WindowsUser\",\r\n \"agentSessionId\": \"00000000-0000-0000-0000-000000000000\",\r\n \"processName\": \"TTT\",\r\n \"fileName\": \"Main\",\r\n \"jobId\": \"8066c309-cef8-4b47-9163-b273fc14cc43\"\r\n }\nDEPRECATED: \nUse SubmitLogs instead\nPlease refer to https://docs.uipath.com/orchestrator/reference", | |
| "operationId": "Logs_Post", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": {} | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successfully inserts a log message. Although it's a post, there's no need for an object to be returned" | |
| }, | |
| "400": { | |
| "description": "jMessage is null or an Exception is thrown during insert" | |
| }, | |
| "408": { | |
| "description": "Too many pending logging requests or timeout" | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/Logs/SubmitLogs": { | |
| "post": { | |
| "tags": [ | |
| "Logs" | |
| ], | |
| "summary": "Inserts a collection of log entries, each in a specific JSON format.", | |
| "description": "OAuth required scopes: OR.Monitoring or OR.Monitoring.Write.\n\nRequired permissions: Logs.Create.\n\nExample of log entry:\r\n {\r\n \"message\": \"TTT execution started\",\r\n \"level\": \"Information\",\r\n \"timeStamp\": \"2017-01-18T14:46:07.4152893+02:00\",\r\n \"windowsIdentity\": \"DESKTOP-1L50L0P\\\\WindowsUser\",\r\n \"agentSessionId\": \"00000000-0000-0000-0000-000000000000\",\r\n \"processName\": \"TTT\",\r\n \"fileName\": \"Main\",\r\n \"jobId\": \"8066c309-cef8-4b47-9163-b273fc14cc43\"\r\n }", | |
| "operationId": "Logs_SubmitLogs", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "Collection of string representations of JSON objects", | |
| "schema": { | |
| "description": "Collection of string representations of JSON objects", | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successfully inserts the log entries" | |
| }, | |
| "400": { | |
| "description": "logs is null or an Exception is thrown during insert" | |
| }, | |
| "408": { | |
| "description": "Too many pending logging requests or timeout" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/Maintenance/End": { | |
| "post": { | |
| "tags": [ | |
| "Maintenance" | |
| ], | |
| "summary": "Ends a maintenance window", | |
| "description": "OAuth required scopes: OR.Administration or OR.Administration.Write.\n\nHost only. Requires authentication.", | |
| "operationId": "Maintenance_End", | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "tenantId", | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/Maintenance/Get": { | |
| "get": { | |
| "tags": [ | |
| "Maintenance" | |
| ], | |
| "summary": "Gets the host admin logs.", | |
| "description": "OAuth required scopes: OR.Administration or OR.Administration.Read.\n\nHost only. Required permissions: Audit.View.", | |
| "operationId": "Maintenance_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "tenantId", | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/MaintenanceSetting" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/Maintenance/Start": { | |
| "post": { | |
| "tags": [ | |
| "Maintenance" | |
| ], | |
| "summary": "Starts a maintenance window", | |
| "description": "OAuth required scopes: OR.Administration or OR.Administration.Write.\n\nHost only. Requires authentication.", | |
| "operationId": "Maintenance_Start", | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "phase", | |
| "description": "Phase - UiPath.Orchestrator.DataContracts.MaintenanceState.Draining or UiPath.Orchestrator.DataContracts.MaintenanceState.Suspended", | |
| "type": "string", | |
| "enum": [ | |
| "None", | |
| "Draining", | |
| "Suspended" | |
| ], | |
| "x-ms-enum": { | |
| "name": "MaintenanceState", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "None", | |
| "Draining", | |
| "Suspended" | |
| ] | |
| }, | |
| { | |
| "in": "query", | |
| "name": "force", | |
| "description": "Whether to ignore errors during transition", | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| { | |
| "in": "query", | |
| "name": "killJobs", | |
| "description": "Whether to force-kill running jobs when transitioning to UiPath.Orchestrator.DataContracts.MaintenanceState.Suspended", | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| { | |
| "in": "query", | |
| "name": "tenantId", | |
| "description": "If tenant id is set, maintenance will start only for this tenant", | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/PackageFeeds/GetFolderFeed": { | |
| "get": { | |
| "tags": [ | |
| "PackageFeeds" | |
| ], | |
| "summary": "Returns the feed id for a user assigned folder having specific feed", | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Read.\n\nRequires authentication.", | |
| "operationId": "PackageFeeds_GetFolderFeed", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "folderId", | |
| "description": "", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/Releases/DeleteByKey": { | |
| "delete": { | |
| "tags": [ | |
| "Releases" | |
| ], | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Write.\n\nRequired permissions: (Processes.Delete).", | |
| "operationId": "Releases_DeleteByKey", | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "key", | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/Stats/GetConsumptionLicenseStats": { | |
| "get": { | |
| "tags": [ | |
| "Stats" | |
| ], | |
| "summary": "Gets the consumption licensing usage statistics", | |
| "description": "OAuth required scopes: OR.Monitoring or OR.Monitoring.Read.\n\nRequired permissions: License.View.", | |
| "operationId": "Stats_GetConsumptionLicenseStats", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "tenantId", | |
| "description": "The Tenant's Id - can be used when authenticated as Host", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "days", | |
| "description": "Number of reported license usage days", | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ConsumptionLicenseStatsModel" | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/Stats/GetCountStats": { | |
| "get": { | |
| "tags": [ | |
| "Stats" | |
| ], | |
| "summary": "Gets the total number of various entities registered in Orchestrator", | |
| "description": "OAuth required scopes: OR.Monitoring or OR.Monitoring.Read.\n\nRequires authentication.\n\nReturns the name and the total number of entities registered in Orchestrator for a set of entities.\r\nAll the counted entity types can be seen in the result below.\r\n [\r\n {\r\n \"title\": \"Processes\",\r\n \"count\": 1\r\n },\r\n {\r\n \"title\": \"Assets\",\r\n \"count\": 0\r\n },\r\n {\r\n \"title\": \"Queues\",\r\n \"count\": 0\r\n },\r\n {\r\n \"title\": \"Schedules\",\r\n \"count\": 0\r\n }\r\n ]", | |
| "operationId": "Stats_GetCountStats", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/CountStats" | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/Stats/GetJobsStats": { | |
| "get": { | |
| "tags": [ | |
| "Stats" | |
| ], | |
| "summary": "Gets the total number of jobs aggregated by Job State", | |
| "description": "OAuth required scopes: OR.Monitoring or OR.Monitoring.Read.\n\nRequired permissions: Jobs.View.\n\nReturns the total number of Successful, Faulted and Canceled jobs respectively.\r\nExample of returned result:\r\n [\r\n {\r\n \"title\": \"Successful\",\r\n \"count\": 0\r\n },\r\n {\r\n \"title\": \"Faulted\",\r\n \"count\": 0\r\n },\r\n {\r\n \"title\": \"Canceled\",\r\n \"count\": 0\r\n }\r\n ]", | |
| "operationId": "Stats_GetJobsStats", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/CountStats" | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/Stats/GetLicenseStats": { | |
| "get": { | |
| "tags": [ | |
| "Stats" | |
| ], | |
| "summary": "Gets the licensing usage statistics", | |
| "description": "OAuth required scopes: OR.Monitoring or OR.Monitoring.Read.\n\nRequired permissions: License.View.", | |
| "operationId": "Stats_GetLicenseStats", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "tenantId", | |
| "description": "The Tenant's Id - can be used when authenticated as Host", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "days", | |
| "description": "Number of reported license usage days", | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/LicenseStatsModel" | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/Stats/GetSessionsStats": { | |
| "get": { | |
| "tags": [ | |
| "Stats" | |
| ], | |
| "summary": "Gets the total number of robots aggregated by Robot State", | |
| "description": "OAuth required scopes: OR.Monitoring or OR.Monitoring.Read.\n\nRequired permissions: Robots.View.\n\nReturns the total number of Available, Busy, Disconnected and Unresponsive robots respectively.\r\nExample of returned result:\r\n [\r\n {\r\n \"title\": \"Available\",\r\n \"count\": 1\r\n },\r\n {\r\n \"title\": \"Busy\",\r\n \"count\": 0\r\n },\r\n {\r\n \"title\": \"Disconnected\",\r\n \"count\": 1\r\n },\r\n {\r\n \"title\": \"Unresponsive\",\r\n \"count\": 0\r\n }\r\n ]", | |
| "operationId": "Stats_GetSessionsStats", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/CountStats" | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/Status/Get": { | |
| "get": { | |
| "tags": [ | |
| "Status" | |
| ], | |
| "summary": "Returns whether the current endpoint should be serving traffic", | |
| "operationId": "Status_Get", | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| } | |
| } | |
| }, | |
| "/api/Status/VerifyHostAvailibility": { | |
| "get": { | |
| "tags": [ | |
| "Status" | |
| ], | |
| "description": "Required permissions: Webhooks.Create or Webhooks.Edit.", | |
| "operationId": "Status_VerifyHostAvailibility", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "url", | |
| "type": "string", | |
| "format": "uri" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/HostAvailabilityDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/TestAutomation/CancelTestCaseExecution": { | |
| "post": { | |
| "tags": [ | |
| "TestAutomation" | |
| ], | |
| "summary": "Cancels the specified test case execution.", | |
| "description": "OAuth required scopes: OR.TestSetExecutions or OR.TestSetExecutions.Write.\n\nRequired permissions: TestSetExecutions.Edit.\n\nResponses:\r\n202 Accepted\r\n403 If the caller doesn't have permissions to cancel a test set execution", | |
| "operationId": "TestAutomation_CancelTestCaseExecution", | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "testCaseExecutionId", | |
| "description": "Id for the test case execution to be canceled", | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "202": { | |
| "description": "The test case execution was scheduled for cancellation or is not in a cancelable state" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/TestAutomation/CancelTestSetExecution": { | |
| "post": { | |
| "tags": [ | |
| "TestAutomation" | |
| ], | |
| "summary": "Cancels the specified test set execution.", | |
| "description": "OAuth required scopes: OR.TestSetExecutions or OR.TestSetExecutions.Write.\n\nRequired permissions: TestSetExecutions.Edit.\n\nResponses:\r\n202 Accepted\r\n403 If the caller doesn't have permissions to cancel a test set execution", | |
| "operationId": "TestAutomation_CancelTestSetExecution", | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "testSetExecutionId", | |
| "description": "Id for the test set execution to be canceled", | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "202": { | |
| "description": "The test set execution was scheduled for cancellation or is not in a cancelable state" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/TestAutomation/CreateTestSetForReleaseVersion": { | |
| "post": { | |
| "tags": [ | |
| "TestAutomation" | |
| ], | |
| "summary": "This will create a test set with source type API.This endpoint it is supposed to be used by API integration.", | |
| "description": "OAuth required scopes: OR.TestSets or OR.TestSets.Write.\n\nRequired permissions: TestSets.Create.\n\nResponses:\r\n201 Created returns test set Id\r\n403 If the caller doesn't have permissions to create a test set", | |
| "operationId": "TestAutomation_CreateTestSetForReleaseVersion", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "schema": { | |
| "$ref": "#/definitions/BuildTestSetRequestMessage" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Successful created test set.", | |
| "schema": { | |
| "format": "int64", | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/TestAutomation/GetAssertionScreenshot": { | |
| "get": { | |
| "tags": [ | |
| "TestAutomation" | |
| ], | |
| "summary": "Get the screenshot for the specified test case assertion.", | |
| "description": "OAuth required scopes: OR.TestSetExecutions or OR.TestSetExecutions.Read.\n\nRequired permissions: TestSetExecutions.View.\n\nResponses:\r\n200 OK\r\n404 If the test case assertion is not found or the screenshot storage location is not found", | |
| "operationId": "TestAutomation_GetAssertionScreenshot", | |
| "produces": [ | |
| "application/octet-stream" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "testCaseAssertionId", | |
| "description": "Id of the test case assertion", | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "format": "file", | |
| "type": "file" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/TestAutomation/GetPackageInfoByTestCaseUniqueId": { | |
| "get": { | |
| "tags": [ | |
| "TestAutomation" | |
| ], | |
| "summary": "Get the package identifier and the latest version for the specified test case.", | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Read.\n\nRequires authentication.\n\nResponses:\r\n200 OK\r\n403 If the caller doesn't have permissions to retrieve packages\r\n404 If there is no test case with the specified UniqueId", | |
| "operationId": "TestAutomation_GetPackageInfoByTestCaseUniqueId", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "testCaseUniqueId", | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "packageIdentifier", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Package info for the specified test case", | |
| "schema": { | |
| "$ref": "#/definitions/TestPackageInfoDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/TestAutomation/GetReleasesForPackageVersion": { | |
| "get": { | |
| "tags": [ | |
| "TestAutomation" | |
| ], | |
| "summary": "This will list all the processes filtered by package identifier and version cross-folder when no current folder is sent by header.", | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Read.\n\nRequired permissions: Processes.View.\n\nResponses:\r\n200 OK\r\n404 If there is no release for the specified package identifier", | |
| "operationId": "TestAutomation_GetReleasesForPackageVersion", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "packageIdentifier", | |
| "description": "", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "version", | |
| "description": "", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "mandatoryPermissions", | |
| "description": "If in a cross-folder scenario, these represent the additional permissions\r\n required in the folders the data is retrieved from; all permissions in this set must be met", | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "atLeastOnePermissions", | |
| "description": "If in a cross-folder scenario, these represent the additional permissions\r\n required in the folders the data is retrieved from; at least one permission in this set must be met", | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "List of process versions", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/TestReleaseVersionDto" | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/TestAutomation/GetTestCaseExecutionAttachment": { | |
| "get": { | |
| "tags": [ | |
| "TestAutomation" | |
| ], | |
| "summary": "Get the attachment for the specified test case execution attachment.", | |
| "description": "OAuth required scopes: OR.TestSetExecutions or OR.TestSetExecutions.Read.\n\nRequired permissions: TestSetExecutions.View.\n\nResponses:\r\n200 OK\r\n404 If the test case execution attachment is not found or the storage location is not found", | |
| "operationId": "TestAutomation_GetTestCaseExecutionAttachment", | |
| "produces": [ | |
| "application/octet-stream" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "testCaseExecutionAttachmentId", | |
| "description": "Id of the test case execution attachment", | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "format": "file", | |
| "type": "file" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/TestAutomation/GetTestCaseExecutionAttachments": { | |
| "post": { | |
| "tags": [ | |
| "TestAutomation" | |
| ], | |
| "summary": "This will list all test case execution attachments filtered by identifier and tags", | |
| "description": "OAuth required scopes: OR.TestSetExecutions or OR.TestSetExecutions.Write.\n\nRequired permissions: TestSetExecutions.View.\n\nResponses:\r\n200 OK\r\n404 If there is no test case execution for the specified identifier", | |
| "operationId": "TestAutomation_GetTestCaseExecutionAttachments", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/TestCaseExecutionAttachmentFilterDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "List of attachments", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/TestCaseExecutionAttachmentDto" | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/TestAutomation/GetTestSetExecutionAttachment": { | |
| "get": { | |
| "tags": [ | |
| "TestAutomation" | |
| ], | |
| "summary": "Get the attachment for the specified test set execution attachment.", | |
| "description": "OAuth required scopes: OR.TestSetExecutions or OR.TestSetExecutions.Read.\n\nRequired permissions: TestSetExecutions.View.\n\nResponses:\r\n200 OK\r\n404 If the test set execution attachment is not found or the storage location is not found", | |
| "operationId": "TestAutomation_GetTestSetExecutionAttachment", | |
| "produces": [ | |
| "application/octet-stream" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "testSetExecutionAttachmentId", | |
| "description": "Id of the test set execution attachment", | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "format": "file", | |
| "type": "file" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/TestAutomation/GetTestSetExecutionAttachments": { | |
| "post": { | |
| "tags": [ | |
| "TestAutomation" | |
| ], | |
| "summary": "This will list all test set execution attachments filtered by identifier and tags", | |
| "description": "OAuth required scopes: OR.TestSetExecutions or OR.TestSetExecutions.Write.\n\nRequired permissions: TestSetExecutions.View.\n\nResponses:\r\n200 OK\r\n404 If there is no test set execution for the specified identifier", | |
| "operationId": "TestAutomation_GetTestSetExecutionAttachments", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/TestSetExecutionAttachmentFilterDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "List of attachments", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/TestSetExecutionAttachmentDto" | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/TestAutomation/ReexecuteTestCases": { | |
| "post": { | |
| "tags": [ | |
| "TestAutomation" | |
| ], | |
| "summary": "Re-execute the specified test case executions within the same test set execution.", | |
| "description": "OAuth required scopes: OR.TestSetExecutions or OR.TestSetExecutions.Write.\n\nRequired permissions: TestSetExecutions.Create.\n\nResponses:\r\n200 OK\r\n403 If the caller doesn't have permissions to execute test sets\r\n404 If one or more test cases were not found", | |
| "operationId": "TestAutomation_ReexecuteTestCases", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "A list of test case executions with corresponding input arguments and optional RobotId and MachineSessionId fields", | |
| "schema": { | |
| "$ref": "#/definitions/ReexecuteTestCasesOptionsDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful re-execution of the test case executions", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/TestCaseExecutionDto" | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/TestAutomation/StartTestSetExecution": { | |
| "post": { | |
| "tags": [ | |
| "TestAutomation" | |
| ], | |
| "summary": "Start a test set execution.", | |
| "description": "OAuth required scopes: OR.TestSetExecutions or OR.TestSetExecutions.Write.\n\nRequired permissions: TestSetExecutions.Create.\n\nResponses:\r\n200 OK returns test set execution Id\r\n403 If the caller doesn't have permissions to execute a test set\r\n404 If the test set was not found", | |
| "operationId": "TestAutomation_StartTestSetExecution", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "testSetId", | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "testSetKey", | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "triggerType", | |
| "description": "Specifies how was the execution triggered", | |
| "type": "string", | |
| "default": "Manual", | |
| "enum": [ | |
| "Manual", | |
| "Scheduled", | |
| "ExternalTool", | |
| "TestManager" | |
| ], | |
| "x-ms-enum": { | |
| "name": "ExecutionTriggerType", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "Manual", | |
| "Scheduled", | |
| "ExternalTool", | |
| "TestManager" | |
| ] | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful start of test set execution", | |
| "schema": { | |
| "format": "int64", | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/TestAutomation/StartTestSetExecutionWithOptions": { | |
| "post": { | |
| "tags": [ | |
| "TestAutomation" | |
| ], | |
| "summary": "Start a test set execution with additional options.", | |
| "description": "OAuth required scopes: OR.TestSetExecutions or OR.TestSetExecutions.Write.\n\nRequired permissions: TestSetExecutions.Create.\n\nResponses:\r\n200 OK returns test set execution Id\r\n403 If the caller doesn't have permissions to execute a test set\r\n404 If the test set was not found", | |
| "operationId": "TestAutomation_StartTestSetExecutionWithOptions", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "Provides options to set the BatchExecutionKey and TriggerType and override the input parameters for specific test cases", | |
| "schema": { | |
| "$ref": "#/definitions/TestSetExecutionOptionsDto" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "testSetId", | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "testSetKey", | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successful start of test set execution", | |
| "schema": { | |
| "format": "int64", | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/TestDataQueueActions/AddItem": { | |
| "post": { | |
| "tags": [ | |
| "TestDataQueueActions" | |
| ], | |
| "summary": "Add a new test data queue item", | |
| "description": "OAuth required scopes: OR.TestDataQueues or OR.TestDataQueues.Write.\n\nRequired permissions: TestDataQueueItems.Create.\n\nResponses:\r\n201 Returns the added test data queue item\r\n403 If the caller doesn't have permissions to create test data queue items\r\n409 If the test data queue item content violates the content JSON schema set on the queue", | |
| "operationId": "TestDataQueueActions_AddItem", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "QueueName: the test data queue name; Content: the item content", | |
| "schema": { | |
| "$ref": "#/definitions/TestDataQueueAddItemDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Returns the added test data queue item", | |
| "schema": { | |
| "$ref": "#/definitions/TestDataQueueItemDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/TestDataQueueActions/BulkAddItems": { | |
| "post": { | |
| "tags": [ | |
| "TestDataQueueActions" | |
| ], | |
| "summary": "Bulk adds an array of data queue items", | |
| "description": "OAuth required scopes: OR.TestDataQueues or OR.TestDataQueues.Write.\n\nRequired permissions: TestDataQueueItems.Create.\n\nResponses:\r\n200 Returns the number of items added\r\n403 If the caller doesn't have permissions to create test data queue items\r\n409 If the test data queue items violates the content JSON schema set on the queue", | |
| "operationId": "TestDataQueueActions_BulkAddItems", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "QueueName: the test data queue name; Items: an array of item content", | |
| "schema": { | |
| "$ref": "#/definitions/TestDataQueueBulkAddItemsDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Returns the number of items added", | |
| "schema": { | |
| "format": "int32", | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/TestDataQueueActions/DeleteAllItems": { | |
| "delete": { | |
| "tags": [ | |
| "TestDataQueueActions" | |
| ], | |
| "summary": "Delete all items from a test data queue", | |
| "description": "OAuth required scopes: OR.TestDataQueues or OR.TestDataQueues.Write.\n\nRequired permissions: TestDataQueueItems.Delete.\n\nResponses:\r\n202 All items from the test data queue were scheduled for deletion\r\n403 If the caller doesn't have permissions to delete test data queue items", | |
| "operationId": "TestDataQueueActions_DeleteAllItems", | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "queueName", | |
| "description": "The name of the test data queue", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "202": { | |
| "description": "All items from the test data queue were scheduled for deletion" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/TestDataQueueActions/DeleteItems": { | |
| "delete": { | |
| "tags": [ | |
| "TestDataQueueActions" | |
| ], | |
| "summary": "Delete specific test data queue items", | |
| "description": "OAuth required scopes: OR.TestDataQueues or OR.TestDataQueues.Write.\n\nRequired permissions: TestDataQueueItems.Delete.\n\nResponses:\r\n204 Deleted the test data queue items\r\n403 If the caller doesn't have permissions to delete test data queue items", | |
| "operationId": "TestDataQueueActions_DeleteItems", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "The Ids of the test data queue items", | |
| "schema": { | |
| "description": "The Ids of the test data queue items", | |
| "type": "array", | |
| "items": { | |
| "format": "int64", | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Deleted the test data queue items" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/TestDataQueueActions/GetNextItem": { | |
| "post": { | |
| "tags": [ | |
| "TestDataQueueActions" | |
| ], | |
| "summary": "Get the next unconsumed test data queue item", | |
| "description": "OAuth required scopes: OR.TestDataQueues or OR.TestDataQueues.Write.\n\nRequired permissions: TestDataQueueItems.View.\n\nResponses:\r\n200 Returns the next unconsumed test data queue item\r\n204 If there are no unconsumed test data queue items in the queue\r\n403 If the caller doesn't have permissions to view test data queue items\r\n404 If the test data queue does not exist", | |
| "operationId": "TestDataQueueActions_GetNextItem", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "QueueName:the test data queue name; SetConsumed: Whether to set the item's IsConsumed flag as true or false", | |
| "schema": { | |
| "$ref": "#/definitions/TestDataQueueGetNextItemDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Returns the next unconsumed test data queue item", | |
| "schema": { | |
| "$ref": "#/definitions/TestDataQueueItemDto" | |
| } | |
| }, | |
| "204": { | |
| "description": "If there are no unconsumed test data queue items in the queue" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/TestDataQueueActions/SetAllItemsConsumed": { | |
| "post": { | |
| "tags": [ | |
| "TestDataQueueActions" | |
| ], | |
| "summary": "Set the IsConsumed flag for all items from a test data queue", | |
| "description": "OAuth required scopes: OR.TestDataQueues or OR.TestDataQueues.Write.\n\nRequired permissions: TestDataQueueItems.Edit.\n\nResponses:\r\n202 All items from the test data queue were scheduled for setting the IsConsumed flag\r\n403 If the caller doesn't have permissions to edit test data queue items", | |
| "operationId": "TestDataQueueActions_SetAllItemsConsumed", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "QueueName: the name of the test data queue; IsConsumed: the value to be set on the items IsConsumed flag", | |
| "schema": { | |
| "$ref": "#/definitions/TestDataQueueSetAllItemsConsumedDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "202": { | |
| "description": "All items from the test data queue were scheduled for setting the IsConsumed flag" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/TestDataQueueActions/SetItemsConsumed": { | |
| "post": { | |
| "tags": [ | |
| "TestDataQueueActions" | |
| ], | |
| "summary": "Set the IsConsumed flag for specific test data queue items", | |
| "description": "OAuth required scopes: OR.TestDataQueues or OR.TestDataQueues.Write.\n\nRequired permissions: TestDataQueueItems.Edit.\n\nResponses:\r\n200 If the operation succeeded\r\n403 If the caller doesn't have permissions to edit test data queue items", | |
| "operationId": "TestDataQueueActions_SetItemsConsumed", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "ItemIds: the list of item ids for which to set the IsConsumed flag; IsConsumed: the value to be set on the items IsConsumed flag", | |
| "schema": { | |
| "$ref": "#/definitions/TestDataQueueSetItemsConsumedDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "If the operation succeeded" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/api/Translations/GetTranslations": { | |
| "get": { | |
| "tags": [ | |
| "Translations" | |
| ], | |
| "summary": "Returns a json with translation resources", | |
| "operationId": "Translations_GetTranslations", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "lang", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/forms/TaskForms/BulkCompleteTasks": { | |
| "post": { | |
| "tags": [ | |
| "TaskForms" | |
| ], | |
| "summary": "Bulk Complete the task by merging form data and action taken", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Write.\n\nRequired permissions: Tasks.Edit.", | |
| "operationId": "TaskForms_BulkCompleteTasks", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "BulkTasksCompletionRequest", | |
| "schema": { | |
| "$ref": "#/definitions/BulkTasksCompletionRequest" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/BulkOperationErrorResponse" | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request" | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/forms/TaskForms/BulkUpdateTasks": { | |
| "put": { | |
| "tags": [ | |
| "TaskForms" | |
| ], | |
| "summary": "Bulk Update Task data by merging data.", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Write.\n\nRequired permissions: Tasks.Edit.", | |
| "operationId": "TaskForms_BulkUpdateTasks", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "BulkTasksDataUpdateRequest", | |
| "schema": { | |
| "$ref": "#/definitions/BulkTasksDataUpdateRequest" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/BulkOperationErrorResponse" | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request" | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/forms/TaskForms/CompleteTask": { | |
| "post": { | |
| "tags": [ | |
| "TaskForms" | |
| ], | |
| "summary": "Complete the task by saving form data and action taken", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Write.\n\nRequired permissions: Tasks.Edit.", | |
| "operationId": "TaskForms_CompleteTask", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "TaskCompletionRequest", | |
| "schema": { | |
| "$ref": "#/definitions/TaskCompletionRequest" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/forms/TaskForms/CreateFormTask": { | |
| "post": { | |
| "tags": [ | |
| "TaskForms" | |
| ], | |
| "summary": "Creates a new Form Task.", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Write.\n\nRequired permissions: Tasks.Create.", | |
| "operationId": "TaskForms_CreateFormTask", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "The form task to be created.", | |
| "schema": { | |
| "$ref": "#/definitions/FormTaskCreateRequest" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Created", | |
| "schema": { | |
| "$ref": "#/definitions/TaskDataDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/forms/TaskForms/GetTaskDataById": { | |
| "get": { | |
| "tags": [ | |
| "TaskForms" | |
| ], | |
| "summary": "Returns task data dto", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Read.\n\nRequired permissions: Tasks.View.", | |
| "operationId": "TaskForms_GetTaskDataById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "taskId", | |
| "description": "Task id", | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/TaskDataDto" | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/forms/TaskForms/GetTaskFormById": { | |
| "get": { | |
| "tags": [ | |
| "TaskForms" | |
| ], | |
| "summary": "Returns form dto to render task form", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Read.\n\nRequired permissions: Tasks.View.", | |
| "operationId": "TaskForms_GetTaskFormById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "taskId", | |
| "description": "Task id", | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "expandOnFormLayout", | |
| "description": "", | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/TaskFormDto" | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/forms/TaskForms/SaveAndReassignTask": { | |
| "post": { | |
| "tags": [ | |
| "TaskForms" | |
| ], | |
| "summary": "Save changes done by the current user and Reassign Task to another user", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Write.\n\nRequired permissions: Tasks.Edit.", | |
| "operationId": "TaskForms_SaveAndReassignTask", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "TaskSaveAndReassignmentRequest", | |
| "schema": { | |
| "$ref": "#/definitions/TaskSaveAndReassignmentRequest" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| }, | |
| "400": { | |
| "description": "Bad Request" | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/forms/TaskForms/SaveTaskData": { | |
| "put": { | |
| "tags": [ | |
| "TaskForms" | |
| ], | |
| "summary": "Save task data", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Write.\n\nRequired permissions: Tasks.Edit.", | |
| "operationId": "TaskForms_SaveTaskData", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "TaskDataSaveRequest", | |
| "schema": { | |
| "$ref": "#/definitions/TaskDataSaveRequest" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| }, | |
| "400": { | |
| "description": "Bad Request" | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Alerts": { | |
| "get": { | |
| "tags": [ | |
| "Alerts" | |
| ], | |
| "summary": "Gets alerts.", | |
| "description": "OAuth required scopes: OR.Monitoring or OR.Monitoring.Read.\n\nRequired permissions: Alerts.View.\nDEPRECATED: \nPlease refer to https://docs.uipath.com/orchestrator/reference", | |
| "operationId": "Alerts_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfAlertDto" | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Alerts/UiPath.Server.Configuration.OData.GetUnreadCount": { | |
| "get": { | |
| "tags": [ | |
| "Alerts" | |
| ], | |
| "summary": "Returns the total number of alerts, per tenant, that haven't been read by the current user.", | |
| "description": "OAuth required scopes: OR.Monitoring or OR.Monitoring.Read.\n\nRequired permissions: Alerts.View.\nDEPRECATED: \nPlease refer to https://docs.uipath.com/orchestrator/reference", | |
| "operationId": "Alerts_GetUnreadCount", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfInt64" | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Alerts/UiPath.Server.Configuration.OData.MarkAsRead": { | |
| "post": { | |
| "tags": [ | |
| "Alerts" | |
| ], | |
| "summary": "Marks alerts as read and returns the remaining number of unread notifications.", | |
| "description": "OAuth required scopes: OR.Monitoring or OR.Monitoring.Write.\n\nRequired permissions: Alerts.View.\nDEPRECATED: \nPlease refer to https://docs.uipath.com/orchestrator/reference", | |
| "operationId": "Alerts_MarkAsRead", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "Collection containing the unique identifiers of the notifications that will be marked as read", | |
| "schema": { | |
| "$ref": "#/definitions/AlertsMarkAsReadRequest" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfInt64" | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Alerts/UiPath.Server.Configuration.OData.RaiseProcessAlert": { | |
| "post": { | |
| "tags": [ | |
| "Alerts" | |
| ], | |
| "summary": "Creates a Process Alert", | |
| "description": "OAuth required scopes: OR.Monitoring or OR.Monitoring.Write.\n\nRequired permissions: Alerts.Create.\nDEPRECATED: \nPlease refer to https://docs.uipath.com/orchestrator/reference", | |
| "operationId": "Alerts_RaiseProcessAlert", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "schema": { | |
| "$ref": "#/definitions/RaiseProcessAlertRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Assets": { | |
| "get": { | |
| "tags": [ | |
| "Assets" | |
| ], | |
| "summary": "Get Assets", | |
| "description": "OAuth required scopes: OR.Assets or OR.Assets.Read.\n\nRequired permissions: Assets.View.\nDEPRECATED: \nReplaced by GetFiltered.\nPlease refer to https://docs.uipath.com/orchestrator/reference", | |
| "operationId": "Assets_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfAssetDto" | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "Assets" | |
| ], | |
| "summary": "Creates an asset", | |
| "description": "OAuth required scopes: OR.Assets or OR.Assets.Write.\n\nRequired permissions: Assets.Create.", | |
| "operationId": "Assets_Post", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/AssetDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Successfully created the asset", | |
| "schema": { | |
| "$ref": "#/definitions/AssetDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Assets({key})": { | |
| "get": { | |
| "tags": [ | |
| "Assets" | |
| ], | |
| "summary": "Gets a single asset based on its id", | |
| "description": "OAuth required scopes: OR.Assets or OR.Assets.Read.\n\nRequired permissions: Assets.View.", | |
| "operationId": "Assets_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/AssetDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "Assets" | |
| ], | |
| "summary": "Edit an asset", | |
| "description": "OAuth required scopes: OR.Assets or OR.Assets.Write.\n\nRequired permissions: Assets.Edit.", | |
| "operationId": "Assets_PutById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/AssetDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successfully updated" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Assets" | |
| ], | |
| "summary": "Delete an asset", | |
| "description": "OAuth required scopes: OR.Assets or OR.Assets.Write.\n\nRequired permissions: Assets.Delete.", | |
| "operationId": "Assets_DeleteById", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Successfully deleted the asset" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Assets/UiPath.Server.Configuration.OData.GetAssetsAcrossFolders": { | |
| "get": { | |
| "tags": [ | |
| "Assets" | |
| ], | |
| "summary": "Get the assets from all the folders in which the current user has the Assets.View permission, except the one specified.", | |
| "description": "OAuth required scopes: OR.Assets or OR.Assets.Read.\n\nRequires authentication.", | |
| "operationId": "Assets_GetAssetsAcrossFolders", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "excludeFolderId", | |
| "description": "", | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfAssetDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Assets/UiPath.Server.Configuration.OData.GetFiltered": { | |
| "get": { | |
| "tags": [ | |
| "Assets" | |
| ], | |
| "summary": "Get Filtered Assets", | |
| "description": "OAuth required scopes: OR.Assets or OR.Assets.Read.\n\nRequired permissions: Assets.View.", | |
| "operationId": "Assets_GetFiltered", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfAssetDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Assets/UiPath.Server.Configuration.OData.GetFoldersForAsset(id={id})": { | |
| "get": { | |
| "tags": [ | |
| "Assets" | |
| ], | |
| "summary": "Get all accesible folders where the asset is shared, and the total count of folders where it is shared (including unaccessible folders).", | |
| "description": "OAuth required scopes: OR.Assets or OR.Assets.Read.\n\nRequires authentication.", | |
| "operationId": "Assets_GetFoldersForAssetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/AccessibleFoldersDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Assets/UiPath.Server.Configuration.OData.GetRobotAsset(robotId='{robotId}',assetName='{assetName}')": { | |
| "get": { | |
| "tags": [ | |
| "Assets" | |
| ], | |
| "summary": "Returns the named asset associated to the given robot key.", | |
| "description": "OAuth required scopes: OR.Assets or OR.Assets.Read.\n\nRequired permissions: Assets.View.\nDEPRECATED: \nUse the GetRobotAssetByNameForRobotKey endpoint. Kept for backwards compatibility.\nPlease refer to https://docs.uipath.com/orchestrator/reference", | |
| "operationId": "Assets_GetRobotAssetByRobotidAndAssetname", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "robotId", | |
| "description": "The key of the robot for which the asset is being fetched.", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "assetName", | |
| "description": "The name of the asset being fetched.", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/UserAssetDto" | |
| } | |
| }, | |
| "400": { | |
| "description": "Invalid parameters" | |
| }, | |
| "404": { | |
| "description": "Asset or Robot do not exist or the Asset is not available for the specified robot." | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Assets/UiPath.Server.Configuration.OData.GetRobotAssetByNameForRobotKey": { | |
| "post": { | |
| "tags": [ | |
| "Assets" | |
| ], | |
| "summary": "Returns the named asset associated to the given robot key.", | |
| "description": "OAuth required scopes: OR.Assets or OR.Assets.Write.\n\nRequired permissions: Assets.View.", | |
| "operationId": "Assets_GetRobotAssetByNameForRobotKey", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/AssetsGetRobotByNameAndKeyRequest" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/UserAssetDto" | |
| } | |
| }, | |
| "400": { | |
| "description": "Invalid parameters" | |
| }, | |
| "404": { | |
| "description": "Asset or Robot do not exist or the Asset is not available for the specified robot." | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Assets/UiPath.Server.Configuration.OData.GetRobotAssetByRobotId(robotId={robotId},assetName='{assetName}')": { | |
| "get": { | |
| "tags": [ | |
| "Assets" | |
| ], | |
| "summary": "Returns the named asset associated to the given robot Id.", | |
| "description": "OAuth required scopes: OR.Assets or OR.Assets.Read.\n\nRequired permissions: Assets.View.", | |
| "operationId": "Assets_GetRobotAssetByRobotId", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "robotId", | |
| "description": "The Id of the robot for which the asset is being fetched.", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "assetName", | |
| "description": "The name of the asset being fetched.", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/UserAssetDto" | |
| } | |
| }, | |
| "400": { | |
| "description": "Invalid parameters" | |
| }, | |
| "404": { | |
| "description": "Asset or Robot do not exist or the Asset is not available for the specified robot." | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Assets/UiPath.Server.Configuration.OData.SetRobotAssetByRobotKey": { | |
| "post": { | |
| "tags": [ | |
| "Assets" | |
| ], | |
| "summary": "Set the asset value associated to the given robot key.", | |
| "description": "OAuth required scopes: OR.Assets or OR.Assets.Write.\n\nRequired permissions: Assets.Edit.", | |
| "operationId": "Assets_SetRobotAssetByRobotKey", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "schema": { | |
| "$ref": "#/definitions/AssetsSetRobotAssetsByKeyRequest" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Successfully updated the asset" | |
| }, | |
| "400": { | |
| "description": "Invalid parameters" | |
| }, | |
| "404": { | |
| "description": "Asset or Robot do not exist or the Asset is not available for the specified robot." | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Assets/UiPath.Server.Configuration.OData.ShareToFolders": { | |
| "post": { | |
| "tags": [ | |
| "Assets" | |
| ], | |
| "summary": "Adds the assets to the folders specified in 'ToAddFolderIds'. Removes the assets from the folders specified in 'ToRemoveFolderIds'.", | |
| "description": "OAuth required scopes: OR.Assets or OR.Assets.Write.\n\nRequires authentication.", | |
| "operationId": "Assets_ShareToFolders", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "Object containing the ids of the assets, the ids of the folders where they should be shared and the ids of the folders from which they should be removed.", | |
| "schema": { | |
| "$ref": "#/definitions/AssetFoldersShareDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| }, | |
| "404": { | |
| "description": "Asset or one of the folders specified does not exist." | |
| }, | |
| "409": { | |
| "description": "Attempt to share between classic or modern or ambigous folders list." | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Attachments": { | |
| "post": { | |
| "tags": [ | |
| "Attachments" | |
| ], | |
| "summary": "Create Attachment", | |
| "description": "OAuth required scopes: OR.Folders or OR.Folders.Write.\n\nRequires authentication.", | |
| "operationId": "Attachments_Post", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "schema": { | |
| "$ref": "#/definitions/AttachmentDto" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Successfully created the attachment", | |
| "schema": { | |
| "$ref": "#/definitions/AttachmentDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Attachments({key})": { | |
| "get": { | |
| "tags": [ | |
| "Attachments" | |
| ], | |
| "summary": "Get Attachment by key", | |
| "description": "OAuth required scopes: OR.Folders or OR.Folders.Read.\n\nRequires authentication.", | |
| "operationId": "Attachments_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/AttachmentDto" | |
| } | |
| }, | |
| "404": { | |
| "description": "Attachment not found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Attachments" | |
| ], | |
| "summary": "Delete attachment", | |
| "description": "OAuth required scopes: OR.Folders or OR.Folders.Write.\n\nRequires authentication.", | |
| "operationId": "Attachments_DeleteById", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/AuditLogs": { | |
| "get": { | |
| "tags": [ | |
| "AuditLogs" | |
| ], | |
| "summary": "Gets Audit logs.", | |
| "description": "OAuth required scopes: OR.Audit or OR.Audit.Read.\n\nRequired permissions: Audit.View.", | |
| "operationId": "AuditLogs_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "header", | |
| "name": "x-UIPATH-AuditedService", | |
| "description": "", | |
| "type": "string", | |
| "default": "Orchestrator", | |
| "enum": [ | |
| "Orchestrator", | |
| "TestAutomation" | |
| ], | |
| "x-ms-enum": { | |
| "name": "AuditedService", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "Orchestrator", | |
| "TestAutomation" | |
| ] | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfAuditLogDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/AuditLogs/UiPath.Server.Configuration.OData.Export": { | |
| "post": { | |
| "tags": [ | |
| "AuditLogs" | |
| ], | |
| "summary": "Requests a CSV export of filtered items.", | |
| "description": "OAuth required scopes: OR.Audit or OR.Audit.Write.\n\nRequired permissions: Audit.View.", | |
| "operationId": "AuditLogs_Export", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "auditedService", | |
| "description": "", | |
| "type": "string", | |
| "default": "Orchestrator", | |
| "enum": [ | |
| "Orchestrator", | |
| "TestAutomation" | |
| ], | |
| "x-ms-enum": { | |
| "name": "AuditedService", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "Orchestrator", | |
| "TestAutomation" | |
| ] | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ExportModel" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/AuditLogs/UiPath.Server.Configuration.OData.GetAuditLogDetails(auditLogId={auditLogId})": { | |
| "get": { | |
| "tags": [ | |
| "AuditLogs" | |
| ], | |
| "summary": "Returns audit log details by audit log id", | |
| "description": "OAuth required scopes: OR.Audit or OR.Audit.Read.\n\nRequired permissions: Audit.View.", | |
| "operationId": "AuditLogs_GetAuditLogDetailsByAuditlogid", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "auditLogId", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "x-UIPATH-AuditedService", | |
| "description": "", | |
| "type": "string", | |
| "default": "Orchestrator", | |
| "enum": [ | |
| "Orchestrator", | |
| "TestAutomation" | |
| ], | |
| "x-ms-enum": { | |
| "name": "AuditedService", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "Orchestrator", | |
| "TestAutomation" | |
| ] | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfAuditLogEntityDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Buckets": { | |
| "post": { | |
| "tags": [ | |
| "Buckets" | |
| ], | |
| "summary": "Creates an Bucket", | |
| "description": "OAuth required scopes: OR.Administration or OR.Administration.Write.\n\nRequired permissions: Buckets.Create.", | |
| "operationId": "Buckets_Post", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/BucketDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Successfully created the bucket", | |
| "schema": { | |
| "$ref": "#/definitions/BucketDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "get": { | |
| "tags": [ | |
| "Buckets" | |
| ], | |
| "summary": "Gets Buckets.", | |
| "description": "OAuth required scopes: OR.Administration or OR.Administration.Read.\n\nRequired permissions: Buckets.View.", | |
| "operationId": "Buckets_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfBucketDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Buckets({key})": { | |
| "get": { | |
| "tags": [ | |
| "Buckets" | |
| ], | |
| "summary": "Gets a single Bucket.", | |
| "description": "OAuth required scopes: OR.Administration or OR.Administration.Read.\n\nRequired permissions: Buckets.View.", | |
| "operationId": "Buckets_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/BucketDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Buckets" | |
| ], | |
| "summary": "Delete a bucket", | |
| "description": "OAuth required scopes: OR.Administration or OR.Administration.Write.\n\nRequired permissions: Buckets.Delete.", | |
| "operationId": "Buckets_DeleteById", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Successfully deleted the bucket" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "Buckets" | |
| ], | |
| "summary": "Updates a bucket.", | |
| "description": "OAuth required scopes: OR.Administration or OR.Administration.Write.\n\nRequired permissions: Buckets.Edit.", | |
| "operationId": "Buckets_PutById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/BucketDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/BucketDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Buckets({key})/UiPath.Server.Configuration.OData.DeleteFile": { | |
| "delete": { | |
| "tags": [ | |
| "Buckets" | |
| ], | |
| "summary": "Deletes a file.", | |
| "description": "OAuth required scopes: OR.Administration or OR.Administration.Write.\n\nRequired permissions: Buckets.View and BlobFiles.Delete.", | |
| "operationId": "Buckets_DeleteFileByKey", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "The Bucket Id", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "path", | |
| "description": "The BlobFile full path", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Buckets({key})/UiPath.Server.Configuration.OData.GetDirectories": { | |
| "get": { | |
| "tags": [ | |
| "Buckets" | |
| ], | |
| "summary": "Gets the child directories in a directory.", | |
| "description": "OAuth required scopes: OR.Administration or OR.Administration.Read.\n\nRequired permissions: Buckets.View and BlobFiles.View.", | |
| "operationId": "Buckets_GetDirectoriesByKey", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "The Bucket Id", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "directory", | |
| "description": "The directory path", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "fileNameGlob", | |
| "description": "Directory listing filter", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Number of directories to return", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Number of directories to skip", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfBlobFileDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Buckets({key})/UiPath.Server.Configuration.OData.GetFile": { | |
| "get": { | |
| "tags": [ | |
| "Buckets" | |
| ], | |
| "summary": "Gets a file metadata.", | |
| "description": "OAuth required scopes: OR.Administration or OR.Administration.Read.\n\nRequired permissions: Buckets.View and BlobFiles.View.", | |
| "operationId": "Buckets_GetFileByKey", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "The Bucket Id", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "path", | |
| "description": "The BlobFile full path", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/BlobFileDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Buckets({key})/UiPath.Server.Configuration.OData.GetFiles": { | |
| "get": { | |
| "tags": [ | |
| "Buckets" | |
| ], | |
| "summary": "Gets the files in a directory.\r\nOptionally returns all files in all child directories (recursive).", | |
| "description": "OAuth required scopes: OR.Administration or OR.Administration.Read.\n\nRequired permissions: Buckets.View and BlobFiles.View.", | |
| "operationId": "Buckets_GetFilesByKey", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "The Bucket Id", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "directory", | |
| "description": "The directory path", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "recursive", | |
| "description": "Recurse subdirectories (flat view)", | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| { | |
| "in": "query", | |
| "name": "fileNameGlob", | |
| "description": "Files listing filter", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Number of files to return", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Number of files to skip", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfBlobFileDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Buckets({key})/UiPath.Server.Configuration.OData.GetReadUri": { | |
| "get": { | |
| "tags": [ | |
| "Buckets" | |
| ], | |
| "summary": "Gets a direct download URL for BlobFile.", | |
| "description": "OAuth required scopes: OR.Administration or OR.Administration.Read.\n\nRequired permissions: Buckets.View and BlobFiles.View.", | |
| "operationId": "Buckets_GetReadUriByKey", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "The Bucket Id", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "path", | |
| "description": "The BlobFile full path", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "expiryInMinutes", | |
| "description": "URL expiration time", | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 0 | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/BlobFileAccessDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Buckets({key})/UiPath.Server.Configuration.OData.GetWriteUri": { | |
| "get": { | |
| "tags": [ | |
| "Buckets" | |
| ], | |
| "summary": "Gets a direct upload URL for BlobFile.", | |
| "description": "OAuth required scopes: OR.Administration or OR.Administration.Read.\n\nRequired permissions: Buckets.View and BlobFiles.Create.", | |
| "operationId": "Buckets_GetWriteUriByKey", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "The Bucket Id", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "path", | |
| "description": "The BlobFile full path", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "expiryInMinutes", | |
| "description": "URL Expiration time", | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 0 | |
| }, | |
| { | |
| "in": "query", | |
| "name": "contentType", | |
| "description": "ContentType for S3 access policy", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/BlobFileAccessDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Buckets/UiPath.Server.Configuration.OData.GetBucketsAcrossFolders": { | |
| "get": { | |
| "tags": [ | |
| "Buckets" | |
| ], | |
| "summary": "Get the buckets from all the folders in which the current user has the Buckets.View permission, except the one specified.", | |
| "description": "OAuth required scopes: OR.Administration or OR.Administration.Read.\n\nRequires authentication.", | |
| "operationId": "Buckets_GetBucketsAcrossFolders", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "excludeFolderId", | |
| "description": "", | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfBucketDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Buckets/UiPath.Server.Configuration.OData.GetFoldersForBucket(id={id})": { | |
| "get": { | |
| "tags": [ | |
| "Buckets" | |
| ], | |
| "summary": "Get all accessible folders where the bucket is shared, and the total count of folders where it is shared (including unaccessible folders).", | |
| "description": "OAuth required scopes: OR.Administration or OR.Administration.Read.\n\nRequires authentication.", | |
| "operationId": "Buckets_GetFoldersForBucketById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/AccessibleFoldersDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Buckets/UiPath.Server.Configuration.OData.ShareToFolders": { | |
| "post": { | |
| "tags": [ | |
| "Buckets" | |
| ], | |
| "summary": "Adds the buckets to the folders specified in 'ToAddFolderIds'. Removes the buckets from the folders specified in 'ToRemoveFolderIds'.", | |
| "description": "OAuth required scopes: OR.Administration or OR.Administration.Write.\n\nRequires authentication.", | |
| "operationId": "Buckets_ShareToFolders", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "Object containing the ids of the buckets and the ids of the folders where they should be shared.", | |
| "schema": { | |
| "$ref": "#/definitions/BucketFoldersShareDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| }, | |
| "404": { | |
| "description": "One of the specified entities does not exist." | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/BusinessRules": { | |
| "get": { | |
| "tags": [ | |
| "BusinessRules" | |
| ], | |
| "summary": "Get Filtered Business Rules", | |
| "description": "OAuth required scopes: OR.BusinessRules or OR.BusinessRules.Read.\n\nRequired permissions: (BusinessRules.View).", | |
| "operationId": "BusinessRules_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfBusinessRuleDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "BusinessRules" | |
| ], | |
| "summary": "Create Business Rule", | |
| "description": "OAuth required scopes: OR.BusinessRules or OR.BusinessRules.Write.\n\nRequired permissions: (BusinessRules.Create).", | |
| "operationId": "BusinessRules_Post", | |
| "consumes": [ | |
| "multipart/form-data" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "formData", | |
| "name": "file", | |
| "required": true, | |
| "type": "file" | |
| }, | |
| { | |
| "in": "formData", | |
| "name": "businessRule", | |
| "description": "The BusinessRuleDto object", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Successfully created the business rule", | |
| "schema": { | |
| "$ref": "#/definitions/BusinessRuleDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/BusinessRules({key})": { | |
| "get": { | |
| "tags": [ | |
| "BusinessRules" | |
| ], | |
| "summary": "Get Business Rule by key", | |
| "description": "OAuth required scopes: OR.BusinessRules or OR.BusinessRules.Read.\n\nRequired permissions: (BusinessRules.View).", | |
| "operationId": "BusinessRules_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/BusinessRuleDto" | |
| } | |
| }, | |
| "404": { | |
| "description": "Business Rule not found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "BusinessRules" | |
| ], | |
| "summary": "Update Business Rule", | |
| "description": "OAuth required scopes: OR.BusinessRules or OR.BusinessRules.Write.\n\nRequired permissions: (BusinessRules.Edit).", | |
| "operationId": "BusinessRules_PutById", | |
| "consumes": [ | |
| "multipart/form-data" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "formData", | |
| "name": "file", | |
| "type": "file" | |
| }, | |
| { | |
| "in": "formData", | |
| "name": "businessRule", | |
| "description": "The BusinessRuleDto object", | |
| "required": true, | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Successfully updated the business rule" | |
| }, | |
| "404": { | |
| "description": "Business Rule not found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "BusinessRules" | |
| ], | |
| "summary": "Delete business rule", | |
| "description": "OAuth required scopes: OR.BusinessRules or OR.BusinessRules.Write.\n\nRequired permissions: (BusinessRules.Delete).", | |
| "operationId": "BusinessRules_DeleteById", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/BusinessRules/UiPath.Server.Configuration.OData.GetBusinessRulesAcrossFolders": { | |
| "get": { | |
| "tags": [ | |
| "BusinessRules" | |
| ], | |
| "summary": "Get the business rules from all the folders in which the current user has the BusinessRules.View permission, except the one specified.", | |
| "description": "OAuth required scopes: OR.BusinessRules or OR.BusinessRules.Read.\n\nRequires authentication.", | |
| "operationId": "BusinessRules_GetBusinessRulesAcrossFolders", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "excludeFolderId", | |
| "description": "", | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfBusinessRuleDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/BusinessRules/UiPath.Server.Configuration.OData.GetFoldersForBusinessRule(id={id})": { | |
| "get": { | |
| "tags": [ | |
| "BusinessRules" | |
| ], | |
| "summary": "Get all accesible folders where the business rule is shared, and the total count of folders where it is shared (including unaccessible folders).", | |
| "description": "OAuth required scopes: OR.BusinessRules or OR.BusinessRules.Read.\n\nRequires authentication.", | |
| "operationId": "BusinessRules_GetFoldersForBusinessRuleById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/AccessibleFoldersDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/BusinessRules/UiPath.Server.Configuration.OData.GetReadUri(name='{name}')": { | |
| "get": { | |
| "tags": [ | |
| "BusinessRules" | |
| ], | |
| "summary": "Get Read URI by Name", | |
| "description": "OAuth required scopes: OR.BusinessRules or OR.BusinessRules.Read.\n\nRequired permissions: (BusinessRules.View).", | |
| "operationId": "BusinessRules_GetReadUriByName", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "name", | |
| "description": "", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "versionNumber", | |
| "description": "", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "expiryInMinutes", | |
| "description": "", | |
| "type": "integer", | |
| "format": "int32", | |
| "default": 0 | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/BusinessRuleVersionDownloadResponse" | |
| } | |
| }, | |
| "404": { | |
| "description": "Business Rule not found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/BusinessRules/UiPath.Server.Configuration.OData.GetVersionList(id={id})": { | |
| "get": { | |
| "tags": [ | |
| "BusinessRules" | |
| ], | |
| "summary": "Get Versions of Business Rule", | |
| "description": "OAuth required scopes: OR.BusinessRules or OR.BusinessRules.Read.\n\nRequired permissions: (BusinessRules.View).", | |
| "operationId": "BusinessRules_GetVersionListById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfBusinessRuleVersionDto" | |
| } | |
| }, | |
| "404": { | |
| "description": "Business Rule not found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/BusinessRules/UiPath.Server.Configuration.OData.ShareToFolders": { | |
| "post": { | |
| "tags": [ | |
| "BusinessRules" | |
| ], | |
| "summary": "Makes the business rule visible in the specified folders.", | |
| "description": "OAuth required scopes: OR.BusinessRules or OR.BusinessRules.Write.\n\nRequires authentication.", | |
| "operationId": "BusinessRules_ShareToFolders", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "Object containing the ids of the business rules and the ids of the folders where they should be shared.", | |
| "schema": { | |
| "$ref": "#/definitions/BusinessRuleFolderShareRequest" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| }, | |
| "404": { | |
| "description": "A business rule or one of the folders specified does not exist." | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Calendars": { | |
| "get": { | |
| "tags": [ | |
| "Calendars" | |
| ], | |
| "summary": "Gets calendars for current tenant.", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Read.\n\nRequires authentication.", | |
| "operationId": "Calendars_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5. The allowed properties are: Name, Id.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfExtendedCalendarDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "Calendars" | |
| ], | |
| "summary": "Creates a new calendar.", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Write.\n\nRequired permissions: (Settings.Create).", | |
| "operationId": "Calendars_Post", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/ExtendedCalendarDto" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Created", | |
| "schema": { | |
| "$ref": "#/definitions/ExtendedCalendarDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Calendars({key})": { | |
| "get": { | |
| "tags": [ | |
| "Calendars" | |
| ], | |
| "summary": "Gets calendar based on its id.", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Read.\n\nRequires authentication.", | |
| "operationId": "Calendars_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ExtendedCalendarDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "Calendars" | |
| ], | |
| "summary": "Edits a calendar.", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Write.\n\nRequired permissions: (Settings.Edit).", | |
| "operationId": "Calendars_PutById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/ExtendedCalendarDto" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ExtendedCalendarDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Calendars" | |
| ], | |
| "summary": "Deletes a calendar.", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Write.\n\nRequired permissions: (Settings.Delete).", | |
| "operationId": "Calendars_DeleteById", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Calendars/UiPath.Server.Configuration.OData.CalendarExists": { | |
| "post": { | |
| "tags": [ | |
| "Calendars" | |
| ], | |
| "summary": "Validate calendar name, and check if it already exists.", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Write.\n\nRequired permissions: (Settings.Edit).", | |
| "operationId": "Calendars_CalendarExists", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/CalendarExistsRequest" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfBoolean" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/CredentialStores": { | |
| "get": { | |
| "tags": [ | |
| "CredentialStores" | |
| ], | |
| "summary": "Gets all Credential Stores.", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Read.\n\nRequired permissions: Settings.View or Assets.Create or Assets.Edit or Assets.View or Robots.Create or Robots.Edit or Robots.View or Buckets.Create or Buckets.Edit.", | |
| "operationId": "CredentialStores_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfCredentialStoreDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "CredentialStores" | |
| ], | |
| "summary": "Creates a new Credential Store.", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Write.\n\nRequired permissions: Settings.Create.", | |
| "operationId": "CredentialStores_Post", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/CredentialStoreDto" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Created", | |
| "schema": { | |
| "$ref": "#/definitions/CredentialStoreDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/CredentialStores({key})": { | |
| "get": { | |
| "tags": [ | |
| "CredentialStores" | |
| ], | |
| "summary": "Gets a single Credential Store by its key.", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Read.\n\nRequired permissions: Settings.View.", | |
| "operationId": "CredentialStores_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/CredentialStoreDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "CredentialStores" | |
| ], | |
| "summary": "Updates a Credential Store.", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Write.\n\nRequired permissions: Settings.Edit.", | |
| "operationId": "CredentialStores_PutById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/CredentialStoreDto" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "CredentialStores" | |
| ], | |
| "summary": "Deletes a Credential Store.", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Write.\n\nRequired permissions: Settings.Delete.", | |
| "operationId": "CredentialStores_DeleteById", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "forceDelete", | |
| "description": "", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/CredentialStores({key})/UiPath.Server.Configuration.OData.SetDefaultStoreForResourceType": { | |
| "post": { | |
| "tags": [ | |
| "CredentialStores" | |
| ], | |
| "summary": "Sets a credential store as the default for the given credential type.", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Write.\n\nRequired permissions: Settings.Edit.", | |
| "operationId": "CredentialStores_SetDefaultStoreForResourceTypeById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "Provides the ID of the credential store to set as default.", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "Provides the resourceType that indicates\r\n the resource type for which the stores becomes default.", | |
| "schema": { | |
| "$ref": "#/definitions/CredentialSetDefaultStoreForResourceTypeRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/CredentialStores/UiPath.Server.Configuration.OData.GetAvailableCredentialStoreTypes": { | |
| "get": { | |
| "tags": [ | |
| "CredentialStores" | |
| ], | |
| "summary": "Gets available Credential Store types.", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Read.\n\nRequired permissions: Settings.View.", | |
| "operationId": "CredentialStores_GetAvailableCredentialStoreTypes", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "proxyId", | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfString" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/CredentialStores/UiPath.Server.Configuration.OData.GetDefaultStoreForResourceType(resourceType='{resourceType}')": { | |
| "get": { | |
| "tags": [ | |
| "CredentialStores" | |
| ], | |
| "summary": "Get the default credential store for the given resource type.", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Read.\n\nRequired permissions: Settings.View or Assets.Create or Assets.Edit or Assets.View or Robots.Create or Robots.Edit or Robots.View or Buckets.Create or Buckets.Edit.", | |
| "operationId": "CredentialStores_GetDefaultStoreForResourceTypeByResourcetype", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "resourceType", | |
| "description": "Provides the resource type for which to retrieve the default.", | |
| "required": true, | |
| "type": "string", | |
| "enum": [ | |
| "AssetCredential", | |
| "RobotCredential", | |
| "BucketCredential", | |
| "Secrets" | |
| ], | |
| "x-ms-enum": { | |
| "name": "CredentialStoreResourceType", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "AssetCredential", | |
| "RobotCredential", | |
| "BucketCredential", | |
| "Secrets" | |
| ] | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfInt64" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/CredentialStores/UiPath.Server.Configuration.OData.GetResourcesForCredentialsProxyResourceTypes(key={key},resourceType='{resourceType}')": { | |
| "get": { | |
| "tags": [ | |
| "CredentialStores" | |
| ], | |
| "summary": "Gets available resources robots (and later assets) for a credential store.", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Read.\n\nRequired permissions: Settings.View.", | |
| "operationId": "CredentialStores_GetResourcesForCredentialsProxyResourceTypes", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "Provides the ID of the credential store for which to retrieve resources.", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "resourceType", | |
| "description": "", | |
| "required": true, | |
| "type": "string", | |
| "enum": [ | |
| "AssetCredential", | |
| "RobotCredential", | |
| "BucketCredential", | |
| "Secrets", | |
| "CredentialStore" | |
| ], | |
| "x-ms-enum": { | |
| "name": "CredentialsProxyResourceType", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "AssetCredential", | |
| "RobotCredential", | |
| "BucketCredential", | |
| "Secrets", | |
| "CredentialStore" | |
| ] | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfCredentialsProxyResourceDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/CredentialStores/UiPath.Server.Configuration.OData.GetResourcesForCredentialStoreTypes(key={key},resourceType='{resourceType}')": { | |
| "get": { | |
| "tags": [ | |
| "CredentialStores" | |
| ], | |
| "summary": "Gets available resources robots (and later assets) for a credential store.", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Read.\n\nRequired permissions: Settings.View.", | |
| "operationId": "CredentialStores_GetResourcesForCredentialStoreTypesByKeyAndResourcetype", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "Provides the ID of the credential store for which to retrieve resources.", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "resourceType", | |
| "description": "", | |
| "required": true, | |
| "type": "string", | |
| "enum": [ | |
| "AssetCredential", | |
| "RobotCredential", | |
| "BucketCredential", | |
| "Secrets" | |
| ], | |
| "x-ms-enum": { | |
| "name": "CredentialStoreResourceType", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "AssetCredential", | |
| "RobotCredential", | |
| "BucketCredential", | |
| "Secrets" | |
| ] | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfCredentialStoreResourceDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/ExecutionMedia": { | |
| "get": { | |
| "tags": [ | |
| "ExecutionMedia" | |
| ], | |
| "description": "OAuth required scopes: OR.Monitoring or OR.Monitoring.Read.\n\nRequired permissions: ExecutionMedia.View.", | |
| "operationId": "ExecutionMedia_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfExecutionMediaDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/ExecutionMedia({key})": { | |
| "get": { | |
| "tags": [ | |
| "ExecutionMedia" | |
| ], | |
| "summary": "Get by id", | |
| "description": "OAuth required scopes: OR.Monitoring or OR.Monitoring.Read.\n\nRequired permissions: ExecutionMedia.View.", | |
| "operationId": "ExecutionMedia_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ExecutionMediaDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/ExecutionMedia/UiPath.Server.Configuration.OData.DeleteMediaByJobId": { | |
| "post": { | |
| "tags": [ | |
| "ExecutionMedia" | |
| ], | |
| "summary": "Deletes the execution media for the given job key.", | |
| "description": "OAuth required scopes: OR.Monitoring or OR.Monitoring.Write.\n\nRequired permissions: ExecutionMedia.Delete.", | |
| "operationId": "ExecutionMedia_DeleteMediaByJobId", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/ExecutionMediaDeleteMediaByJobIdRequest" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/ExecutionMedia/UiPath.Server.Configuration.OData.DownloadMediaByJobId(jobId={jobId})": { | |
| "get": { | |
| "tags": [ | |
| "ExecutionMedia" | |
| ], | |
| "summary": "Downloads execution media by job id", | |
| "description": "OAuth required scopes: OR.Monitoring or OR.Monitoring.Read.\n\nRequired permissions: ExecutionMedia.View.", | |
| "operationId": "ExecutionMedia_DownloadMediaByJobId", | |
| "produces": [ | |
| "application/octet-stream" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "jobId", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "format": "file", | |
| "type": "file" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Exports({key})": { | |
| "get": { | |
| "tags": [ | |
| "Exports" | |
| ], | |
| "description": "Requires authentication.", | |
| "operationId": "Exports_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ExportModel" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Exports({key})/UiPath.Server.Configuration.OData.GetDownloadLink": { | |
| "get": { | |
| "tags": [ | |
| "Exports" | |
| ], | |
| "description": "Requires authentication.", | |
| "operationId": "Exports_GetDownloadLinkById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/BlobFileAccessDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Folders": { | |
| "get": { | |
| "tags": [ | |
| "Folders" | |
| ], | |
| "summary": "Gets folders.", | |
| "description": "OAuth required scopes: OR.Folders or OR.Folders.Read.\n\nRequired permissions: (Units.View or SubFolders.View - Gets all folders or only the folders where user has SubFolders.View permission).", | |
| "operationId": "Folders_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfFolderDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "Folders" | |
| ], | |
| "summary": "Creates a new folder.", | |
| "description": "OAuth required scopes: OR.Folders or OR.Folders.Write.\n\nRequired permissions: (Units.Create or SubFolders.Create - Creates root or subfolder or only subfolder if user has SubFolders.Create permission on parent).", | |
| "operationId": "Folders_Post", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/FolderDto" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Created", | |
| "schema": { | |
| "$ref": "#/definitions/FolderDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Folders({folderId})/UiPath.Server.Configuration.OData.MoveFolder": { | |
| "put": { | |
| "tags": [ | |
| "Folders" | |
| ], | |
| "summary": "Move a folder.", | |
| "description": "OAuth required scopes: OR.Folders or OR.Folders.Write.\n\nRequired permissions: (Units.Delete or SubFolders.Delete - Move any folder or to folder only if user has SubFolders.Delete permission on it) and (Units.Create or SubFolders.Create - Move to any target folder or to folder if user has SubFolders.Create permission on target) and (Units.Edit or SubFolders.Edit - Move to any target folder or to folder if user has SubFolders.Edit permission on target).", | |
| "operationId": "Folders_MoveFolderByFolderid", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "folderId", | |
| "description": "Id of the folder to be moved", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "targetParentId", | |
| "description": "Id of the target parent", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Folders({key})": { | |
| "get": { | |
| "tags": [ | |
| "Folders" | |
| ], | |
| "summary": "Gets a single folder, based on its Id.", | |
| "description": "OAuth required scopes: OR.Folders or OR.Folders.Read.\n\nRequired permissions: (Units.View or SubFolders.View - Gets any folder or only the folder if user has SubFolders.View permission on it or the user is assigned to the folder.).", | |
| "operationId": "Folders_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/FolderDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "Folders" | |
| ], | |
| "summary": "Edits a folder.", | |
| "description": "OAuth required scopes: OR.Folders or OR.Folders.Write.\n\nRequired permissions: (Units.Edit or SubFolders.Edit - Edits any folder or edits only if user has SubFolders.Edit permission on the provided folder).", | |
| "operationId": "Folders_PutById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/FolderDto" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/FolderDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Folders" | |
| ], | |
| "summary": "Deletes a folder. Succeeds only if no entities or user associations\r\nexist in this folder or any of its descendants.", | |
| "description": "OAuth required scopes: OR.Folders or OR.Folders.Write.\n\nRequired permissions: (Units.Delete or SubFolders.Delete - Deletes any folder or only if user has SubFolders.Delete permission on the provided folder).", | |
| "operationId": "Folders_DeleteById", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Deleted" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Folders({key})/UiPath.Server.Configuration.OData.RemoveMachinesFromFolder": { | |
| "post": { | |
| "tags": [ | |
| "Folders" | |
| ], | |
| "summary": "Remove user assignment from a folder.", | |
| "description": "OAuth required scopes: OR.Folders or OR.Folders.Write.\n\nRequired permissions: (Units.Edit or SubFolders.Edit - Removes machines from any folder or only if caller has SubFolders.Edit permission the folder provided).", | |
| "operationId": "Folders_RemoveMachinesFromFolderById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "The Ids of the machines to remove from the folder", | |
| "schema": { | |
| "$ref": "#/definitions/RemoveMachinesFromFolderRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Folders({key})/UiPath.Server.Configuration.OData.RemoveUserFromFolder": { | |
| "post": { | |
| "tags": [ | |
| "Folders" | |
| ], | |
| "summary": "Remove user assignment from a folder.", | |
| "description": "OAuth required scopes: OR.Folders or OR.Folders.Write.\n\nRequired permissions: (Units.Edit or SubFolders.Edit - Remove user from any folder or only if caller has SubFolders.Edit permission on provided folder).", | |
| "operationId": "Folders_RemoveUserFromFolderById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "userId - The Id of the user to remove from the folder", | |
| "schema": { | |
| "$ref": "#/definitions/RemoveUserFromFolderRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Folders({key})/UiPath.Server.Configuration.OData.RemoveUserFromFolderByKey": { | |
| "post": { | |
| "tags": [ | |
| "Folders" | |
| ], | |
| "summary": "Remove user assignment from a folder.", | |
| "description": "OAuth required scopes: OR.Folders or OR.Folders.Write.\n\nRequired permissions: (Units.Edit or SubFolders.Edit - Remove user from any folder or only if caller has SubFolders.Edit permission on provided folder).", | |
| "operationId": "Folders_RemoveUserFromFolderByKey", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "userId - The Id of the user to remove from the folder", | |
| "schema": { | |
| "$ref": "#/definitions/RemoveUserByKeyFromFolderRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Folders/UiPath.Server.Configuration.OData.AssignDomainUser": { | |
| "post": { | |
| "tags": [ | |
| "Folders" | |
| ], | |
| "summary": "Assigns a directory user or group to a set of folders with an optional set of roles per folder.", | |
| "description": "OAuth required scopes: OR.Folders or OR.Folders.Write.\n\nRequired permissions: (Units.Edit or SubFolders.Edit - Assigns domain user to any folder or only if user has SubFolders.Edit permission on all folders provided).", | |
| "operationId": "Folders_AssignDomainUser", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/FolderAssignDomainUserRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Folders/UiPath.Server.Configuration.OData.AssignMachines": { | |
| "post": { | |
| "tags": [ | |
| "Folders" | |
| ], | |
| "summary": "Assigns one or more machines to a set of folders.", | |
| "description": "OAuth required scopes: OR.Folders or OR.Folders.Write.\n\nRequired permissions: (Units.Edit or SubFolders.Edit - Assigns machines to any folder or only if user has SubFolders.Edit permission on all folders provided).", | |
| "operationId": "Folders_AssignMachines", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/FolderAssignMachinesRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Folders/UiPath.Server.Configuration.OData.AssignUsers": { | |
| "post": { | |
| "tags": [ | |
| "Folders" | |
| ], | |
| "summary": "Assigns one or more users to a set of folders with an optional set of roles per folder.", | |
| "description": "OAuth required scopes: OR.Folders or OR.Folders.Write.\n\nRequired permissions: (Units.Edit or SubFolders.Edit - Assigns users to any folder or if the user has SubFolders.Edit permission on all folders provided).", | |
| "operationId": "Folders_AssignUsers", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/FolderAssignUsersRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Folders/UiPath.Server.Configuration.OData.GetAllRolesForUser(username='{username}',skip={skip},take={take})": { | |
| "get": { | |
| "tags": [ | |
| "Folders" | |
| ], | |
| "summary": "Returns a page of the user-folder assignments for the input user, including the roles for each folder.\r\nThe response also includes the folders assigned to the directory groups of the user.\r\nThe distinction between the folders assigned directly to the user and the ones assigned to one of his groups\r\ncan be made via the User field of the response.\r\nLIMITATION: If URI parameters contain special characters (eg. \\, /), use instead api/FoldersNavigation/GetAllRolesForUser endpoint.", | |
| "description": "OAuth required scopes: OR.Folders or OR.Folders.Read.\n\nRequired permissions: (Units.View or SubFolders.View - Gets roles from all folders or only from folders where user has SubFolders.View permission).", | |
| "operationId": "Folders_GetAllRolesForUserByUsernameAndSkipAndTake", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "username", | |
| "description": "User name", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "skip", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "take", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "type", | |
| "description": "", | |
| "type": "string", | |
| "default": "User", | |
| "enum": [ | |
| "User", | |
| "Group", | |
| "Machine", | |
| "Robot", | |
| "ExternalApplication" | |
| ], | |
| "x-ms-enum": { | |
| "name": "DirectoryObjectType", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "User", | |
| "Group", | |
| "Machine", | |
| "Robot", | |
| "ExternalApplication" | |
| ] | |
| }, | |
| { | |
| "in": "query", | |
| "name": "searchText", | |
| "description": "", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/UserRoleAssignmentsDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Folders/UiPath.Server.Configuration.OData.GetByKey(identifier={identifier})": { | |
| "get": { | |
| "tags": [ | |
| "Folders" | |
| ], | |
| "summary": "Gets a single folder, based on its Key.", | |
| "description": "OAuth required scopes: OR.Folders or OR.Folders.Read.\n\nRequired permissions: (Units.View or SubFolders.View - Gets any folder or only the folder if user has SubFolders.View permission on it or the user is assigned to the folder.).", | |
| "operationId": "Folders_GetByKeyByIdentifier", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "identifier", | |
| "description": "", | |
| "required": true, | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/FolderDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Folders/UiPath.Server.Configuration.OData.GetMachinesForFolder(key={key})": { | |
| "get": { | |
| "tags": [ | |
| "Folders" | |
| ], | |
| "summary": "Returns the machines assigned to a folder.", | |
| "description": "OAuth required scopes: OR.Folders or OR.Folders.Read.\n\nRequired permissions: (Units.View or SubFolders.View - Gets machines for any folder or only if user has SubFolders.View permission on folder).", | |
| "operationId": "Folders_GetMachinesForFolderByKey", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfMachineFolderDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Folders/UiPath.Server.Configuration.OData.GetMoveFolderMachinesChanges": { | |
| "get": { | |
| "tags": [ | |
| "Folders" | |
| ], | |
| "summary": "Gets the machine changes when moving a folder", | |
| "description": "OAuth required scopes: OR.Folders or OR.Folders.Read.\n\nRequired permissions: (SubFolders.Delete - Deletes folder only if user has SubFolders.Delete permission on it) and (Units.Create or SubFolders.Create - Creates root or subfolder or only subfolder if user has SubFolders.Create permission on parent) and (Units.Edit or SubFolders.Edit - Edits any folder or only if user has SubFolders.Edit permission on it).", | |
| "operationId": "Folders_GetMoveFolderMachinesChanges", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "folderId", | |
| "description": "Id of the folder to be moved", | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "targetParentId", | |
| "description": "Id of the target parent", | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfMoveFolderMachineChange" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Folders/UiPath.Server.Configuration.OData.GetSubfoldersWithAssignedMachine": { | |
| "get": { | |
| "tags": [ | |
| "Folders" | |
| ], | |
| "summary": "Gets direct machine assignments for all subfolders of the specific folder", | |
| "description": "OAuth required scopes: OR.Folders or OR.Folders.Read.\n\nRequired permissions: (Units.View or SubFolders.View - Gets the subfolders in which the machines is directly assigned for any folder or for subfolders only).", | |
| "operationId": "Folders_GetSubfoldersWithAssignedMachine", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "rootFolderId", | |
| "description": "", | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "machineId", | |
| "description": "", | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfFolderDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Folders/UiPath.Server.Configuration.OData.GetUsersForFolder(key={key},includeInherited={includeInherited})": { | |
| "get": { | |
| "tags": [ | |
| "Folders" | |
| ], | |
| "summary": "Returns the users who have access to a folder and optionally the fine-grained roles each one\r\nhas on that folder.", | |
| "description": "OAuth required scopes: OR.Folders or OR.Folders.Read.\n\nRequired permissions: (Units.View or SubFolders.View or Assets.Create or Assets.Edit - Gets users for any folder or if the user has SubFolders.View/Assets.Create/Assets.Edit permission on the provided folder).", | |
| "operationId": "Folders_GetUsersForFolderByKeyAndIncludeinherited", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "includeInherited", | |
| "description": "If true, the response will include users inherited from ancestors", | |
| "required": true, | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "includeAlertsEnabled", | |
| "description": "If true, the response will include alert preferences for each user", | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfUserRolesDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Folders/UiPath.Server.Configuration.OData.ToggleFolderMachineInherit": { | |
| "post": { | |
| "tags": [ | |
| "Folders" | |
| ], | |
| "summary": "Toggle machine propagation for a folder to all subfolders.", | |
| "description": "OAuth required scopes: OR.Folders or OR.Folders.Write.\n\nRequired permissions: (Units.Edit or SubFolders.Edit - Propagate machine to subfolders only if Units.Edit permission is provided or only if SubFolders.Edit permission on all folders provided).", | |
| "operationId": "Folders_ToggleFolderMachineInherit", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/FolderMachineInheritDto" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Folders/UiPath.Server.Configuration.OData.UpdateMachinesToFolderAssociations": { | |
| "post": { | |
| "tags": [ | |
| "Folders" | |
| ], | |
| "summary": "Add and remove machine associations to a folder", | |
| "description": "OAuth required scopes: OR.Folders or OR.Folders.Write.\n\nRequired permissions: (Units.Edit or SubFolders.Edit - Update machines to any folder associations or only if user has SubFolders.Edit permission on all folders provided).", | |
| "operationId": "Folders_UpdateMachinesToFolderAssociations", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/UpdateMachinesToFolderAssociationsRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Jobs": { | |
| "get": { | |
| "tags": [ | |
| "Jobs" | |
| ], | |
| "summary": "Gets Jobs.", | |
| "description": "OAuth required scopes: OR.Jobs or OR.Jobs.Read.\n\nRequired permissions: Jobs.View.", | |
| "operationId": "Jobs_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "mandatoryPermissions", | |
| "description": "If in a cross-folder scenario, these represent the additional permissions\r\n required in the folders the data is retrieved from; all permissions in this set must be met", | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "atLeastOnePermissions", | |
| "description": "If in a cross-folder scenario, these represent the additional permissions\r\n required in the folders the data is retrieved from; at least one permission in this set must be met", | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfJobDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Jobs({key})": { | |
| "get": { | |
| "tags": [ | |
| "Jobs" | |
| ], | |
| "summary": "Gets a single job.", | |
| "description": "OAuth required scopes: OR.Jobs or OR.Jobs.Read.\n\nRequired permissions: (Jobs.View).", | |
| "operationId": "Jobs_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/JobDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Jobs({key})/UiPath.Server.Configuration.OData.StopJob": { | |
| "post": { | |
| "tags": [ | |
| "Jobs" | |
| ], | |
| "summary": "Cancels or terminates the specified job.", | |
| "description": "OAuth required scopes: OR.Jobs or OR.Jobs.Write.\n\nRequired permissions: Jobs.Edit.", | |
| "operationId": "Jobs_StopJobById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "The specified job's Id.", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "Strategy - States whether a job should be soft stopped or killed immediately.", | |
| "schema": { | |
| "$ref": "#/definitions/StopJobRequest" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Jobs({key})/UiPath.Server.Configuration.OData.ValidateExistingJob": { | |
| "post": { | |
| "tags": [ | |
| "Jobs" | |
| ], | |
| "summary": "Validates an existing job.", | |
| "description": "OAuth required scopes: OR.Jobs or OR.Jobs.Write.\n\nRequired permissions: (Jobs.View).", | |
| "operationId": "Jobs_ValidateExistingJobById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ValidationResultDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Jobs/UiPath.Server.Configuration.OData.Export": { | |
| "post": { | |
| "tags": [ | |
| "Jobs" | |
| ], | |
| "summary": "Requests a CSV export of filtered items.", | |
| "description": "OAuth required scopes: OR.Jobs or OR.Jobs.Write.\n\nRequired permissions: Jobs.View.", | |
| "operationId": "Jobs_Export", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ExportModel" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Jobs/UiPath.Server.Configuration.OData.RestartJob": { | |
| "post": { | |
| "tags": [ | |
| "Jobs" | |
| ], | |
| "summary": "Restarts the specified job.", | |
| "description": "OAuth required scopes: OR.Jobs or OR.Jobs.Write.\n\nRequired permissions: Jobs.Create.", | |
| "operationId": "Jobs_RestartJob", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "The specified job id.", | |
| "schema": { | |
| "$ref": "#/definitions/RestartJobRequest" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/JobDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Jobs/UiPath.Server.Configuration.OData.ResumeJob": { | |
| "post": { | |
| "tags": [ | |
| "Jobs" | |
| ], | |
| "summary": "Resumes the specified job.", | |
| "description": "OAuth required scopes: OR.Jobs or OR.Jobs.Write.\n\nRequired permissions: Jobs.Edit.", | |
| "operationId": "Jobs_ResumeJob", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "The specified job key.", | |
| "schema": { | |
| "$ref": "#/definitions/ResumeJobRequest" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/JobDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs": { | |
| "post": { | |
| "tags": [ | |
| "Jobs" | |
| ], | |
| "summary": "Adds a new job and sets it in Pending state for each robot based on the input parameters and notifies the respective robots about the pending job.", | |
| "description": "OAuth required scopes: OR.Jobs or OR.Jobs.Write.\n\nRequired permissions: Jobs.Create.", | |
| "operationId": "Jobs_StartJobs", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "StartInfo - The information required to register the new jobs.", | |
| "schema": { | |
| "$ref": "#/definitions/StartJobsRequest" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Created", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfJobDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Jobs/UiPath.Server.Configuration.OData.StopJobs": { | |
| "post": { | |
| "tags": [ | |
| "Jobs" | |
| ], | |
| "summary": "Cancels or terminates the specified jobs.", | |
| "description": "OAuth required scopes: OR.Jobs or OR.Jobs.Write.\n\nRequired permissions: Jobs.Edit.", | |
| "operationId": "Jobs_StopJobs", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "JobIds - The ids for the jobs to be canceled or terminated;\r\n Strategy - States whether a job should be soft stopped or killed immediately.", | |
| "schema": { | |
| "$ref": "#/definitions/StopJobsRequest" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Jobs/UiPath.Server.Configuration.OData.ValidateDynamicJob": { | |
| "post": { | |
| "tags": [ | |
| "Jobs" | |
| ], | |
| "summary": "Validates the input which would start a job.", | |
| "description": "OAuth required scopes: OR.Jobs or OR.Jobs.Write.\n\nRequired permissions: Jobs.Create.", | |
| "operationId": "Jobs_ValidateDynamicJob", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "StartInfo - The same input which would be used to start a new job.", | |
| "schema": { | |
| "$ref": "#/definitions/StartJobsRequest" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ValidationResultDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/JobTriggers": { | |
| "get": { | |
| "tags": [ | |
| "JobTriggers" | |
| ], | |
| "summary": "Gets JobTriggers.", | |
| "description": "OAuth required scopes: OR.Jobs or OR.Jobs.Read.\n\nRequired permissions: Jobs.View.", | |
| "operationId": "JobTriggers_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfJobTriggerDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/JobTriggers/UiPath.Server.Configuration.OData.GetByJobKey(jobKey={jobKey})": { | |
| "get": { | |
| "tags": [ | |
| "JobTriggers" | |
| ], | |
| "summary": "Gets Trigger option for a job instance along with wait event details .", | |
| "description": "OAuth required scopes: OR.Jobs or OR.Jobs.Read.\n\nRequired permissions: Jobs.View.", | |
| "operationId": "JobTriggers_GetByJobKey", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "jobKey", | |
| "description": "", | |
| "required": true, | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfJobTriggerDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/JobTriggers/UiPath.Server.Configuration.OData.GetWithWaitEvents(jobId={jobId})": { | |
| "get": { | |
| "tags": [ | |
| "JobTriggers" | |
| ], | |
| "summary": "Gets Trigger option for a job instance along with wait event details .", | |
| "description": "OAuth required scopes: OR.Jobs or OR.Jobs.Read.\n\nRequired permissions: Jobs.View.", | |
| "operationId": "JobTriggers_GetWithWaitEventsByJobid", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "jobId", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfJobTriggerWithWaitEventsDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Libraries": { | |
| "get": { | |
| "tags": [ | |
| "Libraries" | |
| ], | |
| "summary": "Gets the library packages.", | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Read.\n\nRequired permissions: Libraries.View.", | |
| "operationId": "Libraries_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "searchTerm", | |
| "description": "", | |
| "type": "string", | |
| "default": "" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "feedId", | |
| "description": "", | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfLibraryDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Libraries('{key}')": { | |
| "delete": { | |
| "tags": [ | |
| "Libraries" | |
| ], | |
| "summary": "Deletes a package.", | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Write.\n\nRequired permissions: Libraries.Delete.", | |
| "operationId": "Libraries_DeleteById", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "feedId", | |
| "description": "", | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Deleted" | |
| }, | |
| "200": { | |
| "description": "Package deleted" | |
| }, | |
| "400": { | |
| "description": "Bad Request" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Libraries/UiPath.Server.Configuration.OData.DownloadPackage(key='{key}')": { | |
| "get": { | |
| "tags": [ | |
| "Libraries" | |
| ], | |
| "summary": "Downloads the .nupkg file of a Package.", | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Read.\n\nRequired permissions: Libraries.View.", | |
| "operationId": "Libraries_DownloadPackageByKey", | |
| "produces": [ | |
| "application/octet-stream" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "feedId", | |
| "description": "", | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "format": "file", | |
| "type": "file" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Libraries/UiPath.Server.Configuration.OData.GetVersions(packageId='{packageId}')": { | |
| "get": { | |
| "tags": [ | |
| "Libraries" | |
| ], | |
| "summary": "Returns a collection of all available versions of a given package. Allows odata query options.", | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Read.\n\nRequired permissions: Libraries.View.", | |
| "operationId": "Libraries_GetVersionsByPackageid", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "packageId", | |
| "description": "The Id of the package for which the versions are fetched.", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "feedId", | |
| "description": "", | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfLibraryDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Libraries/UiPath.Server.Configuration.OData.UploadPackage": { | |
| "post": { | |
| "tags": [ | |
| "Libraries" | |
| ], | |
| "summary": "Uploads a new package or a new version of an existing package. The content of the package is sent as a .nupkg file embedded in the HTTP request.", | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Write.\n\nRequired permissions: Libraries.Create.", | |
| "operationId": "Libraries_UploadPackage", | |
| "consumes": [ | |
| "multipart/form-data" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "feedId", | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "formData", | |
| "name": "file1", | |
| "type": "file" | |
| }, | |
| { | |
| "in": "formData", | |
| "name": "file2", | |
| "type": "file" | |
| }, | |
| { | |
| "in": "formData", | |
| "name": "file3", | |
| "type": "file" | |
| }, | |
| { | |
| "in": "formData", | |
| "name": "file4", | |
| "type": "file" | |
| }, | |
| { | |
| "in": "formData", | |
| "name": "file5", | |
| "type": "file" | |
| }, | |
| { | |
| "in": "formData", | |
| "name": "file6", | |
| "type": "file" | |
| }, | |
| { | |
| "in": "formData", | |
| "name": "file7", | |
| "type": "file" | |
| }, | |
| { | |
| "in": "formData", | |
| "name": "file8", | |
| "type": "file" | |
| }, | |
| { | |
| "in": "formData", | |
| "name": "file9", | |
| "type": "file" | |
| }, | |
| { | |
| "in": "formData", | |
| "name": "file", | |
| "required": true, | |
| "type": "file" | |
| } | |
| ], | |
| "responses": { | |
| "207": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfBulkItemDtoOfString" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/LicensesNamedUser/UiPath.Server.Configuration.OData.GetLicensesNamedUser(robotType='{robotType}')": { | |
| "get": { | |
| "tags": [ | |
| "LicensesNamedUser" | |
| ], | |
| "summary": "Gets named-user licenses.", | |
| "description": "OAuth required scopes: OR.License or OR.License.Read.\n\nRequired permissions: License.View.", | |
| "operationId": "LicensesNamedUser_GetLicensesNamedUserByRobottype", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "robotType", | |
| "description": "", | |
| "required": true, | |
| "type": "string", | |
| "enum": [ | |
| "NonProduction", | |
| "Attended", | |
| "Unattended", | |
| "Development", | |
| "Studio", | |
| "RpaDeveloper", | |
| "StudioX", | |
| "CitizenDeveloper", | |
| "Headless", | |
| "StudioPro", | |
| "RpaDeveloperPro", | |
| "TestAutomation", | |
| "AutomationCloud", | |
| "Serverless", | |
| "AutomationKit", | |
| "ServerlessTestAutomation", | |
| "AutomationCloudTestAutomation", | |
| "AttendedStudioWeb", | |
| "Hosting", | |
| "AssistantWeb", | |
| "ProcessOrchestration", | |
| "AgentService", | |
| "AppTest", | |
| "PerformanceTest", | |
| "BusinessRule", | |
| "CaseManagement" | |
| ], | |
| "x-ms-enum": { | |
| "name": "RobotType", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "NonProduction", | |
| "Attended", | |
| "Unattended", | |
| "Development", | |
| "Studio", | |
| "RpaDeveloper", | |
| "StudioX", | |
| "CitizenDeveloper", | |
| "Headless", | |
| "StudioPro", | |
| "RpaDeveloperPro", | |
| "TestAutomation", | |
| "AutomationCloud", | |
| "Serverless", | |
| "AutomationKit", | |
| "ServerlessTestAutomation", | |
| "AutomationCloudTestAutomation", | |
| "AttendedStudioWeb", | |
| "Hosting", | |
| "AssistantWeb", | |
| "ProcessOrchestration", | |
| "AgentService", | |
| "AppTest", | |
| "PerformanceTest", | |
| "BusinessRule", | |
| "CaseManagement" | |
| ] | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfLicenseNamedUserDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/LicensesRuntime('{key}')/UiPath.Server.Configuration.OData.ToggleEnabled": { | |
| "post": { | |
| "tags": [ | |
| "LicensesRuntime" | |
| ], | |
| "summary": "Toggles machine licensing on/off.", | |
| "description": "OAuth required scopes: OR.License or OR.License.Write.\n\nRequired permissions: Machines.Edit.", | |
| "operationId": "LicensesRuntime_ToggleEnabledByKey", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/LicensesToggleEnabledRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| }, | |
| "409": { | |
| "description": "Conflict" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/LicensesRuntime/UiPath.Server.Configuration.OData.GetLicensesRuntime(robotType='{robotType}')": { | |
| "get": { | |
| "tags": [ | |
| "LicensesRuntime" | |
| ], | |
| "summary": "Gets runtime licenses.", | |
| "description": "OAuth required scopes: OR.License or OR.License.Read.\n\nRequired permissions: License.View.", | |
| "operationId": "LicensesRuntime_GetLicensesRuntimeByRobottype", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "robotType", | |
| "description": "", | |
| "required": true, | |
| "type": "string", | |
| "enum": [ | |
| "NonProduction", | |
| "Attended", | |
| "Unattended", | |
| "Development", | |
| "Studio", | |
| "RpaDeveloper", | |
| "StudioX", | |
| "CitizenDeveloper", | |
| "Headless", | |
| "StudioPro", | |
| "RpaDeveloperPro", | |
| "TestAutomation", | |
| "AutomationCloud", | |
| "Serverless", | |
| "AutomationKit", | |
| "ServerlessTestAutomation", | |
| "AutomationCloudTestAutomation", | |
| "AttendedStudioWeb", | |
| "Hosting", | |
| "AssistantWeb", | |
| "ProcessOrchestration", | |
| "AgentService", | |
| "AppTest", | |
| "PerformanceTest", | |
| "BusinessRule", | |
| "CaseManagement" | |
| ], | |
| "x-ms-enum": { | |
| "name": "RobotType", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "NonProduction", | |
| "Attended", | |
| "Unattended", | |
| "Development", | |
| "Studio", | |
| "RpaDeveloper", | |
| "StudioX", | |
| "CitizenDeveloper", | |
| "Headless", | |
| "StudioPro", | |
| "RpaDeveloperPro", | |
| "TestAutomation", | |
| "AutomationCloud", | |
| "Serverless", | |
| "AutomationKit", | |
| "ServerlessTestAutomation", | |
| "AutomationCloudTestAutomation", | |
| "AttendedStudioWeb", | |
| "Hosting", | |
| "AssistantWeb", | |
| "ProcessOrchestration", | |
| "AgentService", | |
| "AppTest", | |
| "PerformanceTest", | |
| "BusinessRule", | |
| "CaseManagement" | |
| ] | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfLicenseRuntimeDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Machines": { | |
| "get": { | |
| "tags": [ | |
| "Machines" | |
| ], | |
| "summary": "Gets machines.", | |
| "description": "OAuth required scopes: OR.Machines or OR.Machines.Read.\n\nRequired permissions: Machines.View.", | |
| "operationId": "Machines_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfExtendedMachineDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "Machines" | |
| ], | |
| "summary": "Creates a new machine.", | |
| "description": "OAuth required scopes: OR.Machines or OR.Machines.Write.\n\nRequired permissions: Machines.Create.", | |
| "operationId": "Machines_Post", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/MachineDto" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Created", | |
| "schema": { | |
| "$ref": "#/definitions/MachineDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Machines({key})": { | |
| "get": { | |
| "tags": [ | |
| "Machines" | |
| ], | |
| "summary": "Gets a single machine based on its id.", | |
| "description": "OAuth required scopes: OR.Machines or OR.Machines.Read.\n\nRequired permissions: Machines.View.", | |
| "operationId": "Machines_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/MachineDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "Machines" | |
| ], | |
| "summary": "Edits a machine based on its key.", | |
| "description": "OAuth required scopes: OR.Machines or OR.Machines.Write.\n\nRequired permissions: Machines.Edit.", | |
| "operationId": "Machines_PutById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/MachineDto" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "Machines" | |
| ], | |
| "summary": "Partially updates a machine.", | |
| "description": "OAuth required scopes: OR.Machines or OR.Machines.Write.\n\nRequired permissions: Machines.Edit.", | |
| "operationId": "Machines_PatchById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/MachineDto" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Machines" | |
| ], | |
| "summary": "Deletes a machine based on its key.", | |
| "description": "OAuth required scopes: OR.Machines or OR.Machines.Write.\n\nRequired permissions: Machines.Delete.", | |
| "operationId": "Machines_DeleteById", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Machines/UiPath.Server.Configuration.OData.DeleteBulk": { | |
| "post": { | |
| "tags": [ | |
| "Machines" | |
| ], | |
| "summary": "Deletes multiple machines based on their keys.", | |
| "description": "OAuth required scopes: OR.Machines or OR.Machines.Write.\n\nRequired permissions: Machines.Delete.", | |
| "operationId": "Machines_DeleteBulk", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/MachineDeleteBulkRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| }, | |
| "400": { | |
| "description": "Empty machineIds collection in payload" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Machines/UiPath.Server.Configuration.OData.GetAssignedMachines(folderId={folderId})": { | |
| "get": { | |
| "tags": [ | |
| "Machines" | |
| ], | |
| "summary": "Gets machines assigned to folder and robot", | |
| "description": "OAuth required scopes: OR.Machines or OR.Machines.Read.\n\nRequired permissions: (Machines.View or Jobs.Create).", | |
| "operationId": "Machines_GetAssignedMachinesByFolderid", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "folderId", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "robotId", | |
| "description": "", | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfMachineDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Machines/UiPath.Server.Configuration.OData.GetRuntimesForFolder(folderId={folderId})": { | |
| "get": { | |
| "tags": [ | |
| "Machines" | |
| ], | |
| "summary": "Gets runtimes for the specified folder", | |
| "description": "OAuth required scopes: OR.Machines or OR.Machines.Read.\n\nRequired permissions: (Machines.View or Jobs.Create).", | |
| "operationId": "Machines_GetRuntimesForFolderByFolderid", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "folderId", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfMachineRuntimeDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Permissions": { | |
| "get": { | |
| "tags": [ | |
| "Permissions" | |
| ], | |
| "summary": "Gets permissions.", | |
| "operationId": "Permissions_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfPermissionDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/PersonalWorkspaces": { | |
| "get": { | |
| "tags": [ | |
| "PersonalWorkspaces" | |
| ], | |
| "summary": "Gets Personal Workspaces.", | |
| "description": "OAuth required scopes: OR.Folders or OR.Folders.Read.\n\nRequired permissions: Units.View.", | |
| "operationId": "PersonalWorkspaces_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfPersonalWorkspaceDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/PersonalWorkspaces({key})/UiPath.Server.Configuration.OData.ConvertToFolder": { | |
| "post": { | |
| "tags": [ | |
| "PersonalWorkspaces" | |
| ], | |
| "summary": "Converts a Personal Workspace to a standard Folder.", | |
| "description": "OAuth authentication is not supported.\n\nRequired permissions: Units.Edit.", | |
| "operationId": "PersonalWorkspaces_ConvertToFolderById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "schema": { | |
| "$ref": "#/definitions/PersonalWorkspacesConvertToFolderRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/PersonalWorkspaces({key})/UiPath.Server.Configuration.OData.StartExploring": { | |
| "post": { | |
| "tags": [ | |
| "PersonalWorkspaces" | |
| ], | |
| "summary": "Assigns the current User to explore a Personal Workspace.", | |
| "description": "OAuth authentication is not supported.\n\nRequired permissions: Units.Edit and Users.View and Roles.View.", | |
| "operationId": "PersonalWorkspaces_StartExploringById", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/PersonalWorkspaces({key})/UiPath.Server.Configuration.OData.StopExploring": { | |
| "post": { | |
| "tags": [ | |
| "PersonalWorkspaces" | |
| ], | |
| "summary": "Unassigns the current User from exploring a Personal Workspace.", | |
| "description": "OAuth authentication is not supported.\n\nRequired permissions: Units.Edit and Users.View and Roles.View.", | |
| "operationId": "PersonalWorkspaces_StopExploringById", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/PersonalWorkspaces/UiPath.Server.Configuration.OData.GetPersonalWorkspace": { | |
| "get": { | |
| "tags": [ | |
| "PersonalWorkspaces" | |
| ], | |
| "summary": "Gets Personal Workspace for current User", | |
| "description": "OAuth authentication is not supported.\n\nRequires authentication.", | |
| "operationId": "PersonalWorkspaces_GetPersonalWorkspace", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/PersonalWorkspaceDto" | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Processes": { | |
| "get": { | |
| "tags": [ | |
| "Processes" | |
| ], | |
| "summary": "Gets the processes.", | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Read.\n\nRequired permissions: (Packages.View - Lists packages in a Tenant Feed) and (FolderPackages.View - Lists packages in a Folder Feed).", | |
| "operationId": "Processes_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "searchTerm", | |
| "description": "", | |
| "type": "string", | |
| "default": "" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "feedId", | |
| "description": "", | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfProcessDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Processes('{key}')": { | |
| "delete": { | |
| "tags": [ | |
| "Processes" | |
| ], | |
| "summary": "Deletes a package.", | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Write.\n\nRequired permissions: (Packages.Delete - Deletes a package in a Tenant Feed) and (FolderPackages.Delete - Deletes a package in a Folder Feed).", | |
| "operationId": "Processes_DeleteById", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "feedId", | |
| "description": "", | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Deleted" | |
| }, | |
| "200": { | |
| "description": "Package deleted" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Processes/UiPath.Server.Configuration.OData.DownloadPackage(key='{key}')": { | |
| "get": { | |
| "tags": [ | |
| "Processes" | |
| ], | |
| "summary": "Downloads the .nupkg file of a Package.", | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Read.\n\nRequired permissions: (Packages.View - Downloads a package from a Tenant Feed) and (FolderPackages.View - Downloads a package from a Folder Feed).", | |
| "operationId": "Processes_DownloadPackageByKey", | |
| "produces": [ | |
| "application/octet-stream" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "feedId", | |
| "description": "", | |
| "type": "string", | |
| "format": "uuid" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "format": "file", | |
| "type": "file" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Processes/UiPath.Server.Configuration.OData.GetArguments(key='{key}')": { | |
| "get": { | |
| "tags": [ | |
| "Processes" | |
| ], | |
| "summary": "Get process parameters", | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Read.\n\nRequired permissions: Packages.View.", | |
| "operationId": "Processes_GetArgumentsByKey", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ArgumentMetadata" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Processes/UiPath.Server.Configuration.OData.GetProcessVersions(processId='{processId}')": { | |
| "get": { | |
| "tags": [ | |
| "Processes" | |
| ], | |
| "summary": "Returns a collection of all available versions of a given process. Allows odata query options.", | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Read.\n\nRequired permissions: (Packages.View - Lists versions of a package in a Tenant Feed) and (FolderPackages.View - Lists versions of a package in a Folder Feed).", | |
| "operationId": "Processes_GetProcessVersionsByProcessid", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "processId", | |
| "description": "The Id of the process for which the versions are fetched.", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "feedId", | |
| "description": "", | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfProcessDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Processes/UiPath.Server.Configuration.OData.UploadPackage": { | |
| "post": { | |
| "tags": [ | |
| "Processes" | |
| ], | |
| "summary": "Uploads a new package or a new version of an existing package. The content of the package is sent as a .nupkg file embedded in the HTTP request.", | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Write.\n\nRequired permissions: (Packages.Create - Uploads a package in a Tenant Feed) and (FolderPackages.Create - Uploads a package in a Folder Feed).", | |
| "operationId": "Processes_UploadPackage", | |
| "consumes": [ | |
| "multipart/form-data" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "feedId", | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "formData", | |
| "name": "file1", | |
| "type": "file" | |
| }, | |
| { | |
| "in": "formData", | |
| "name": "file2", | |
| "type": "file" | |
| }, | |
| { | |
| "in": "formData", | |
| "name": "file3", | |
| "type": "file" | |
| }, | |
| { | |
| "in": "formData", | |
| "name": "file4", | |
| "type": "file" | |
| }, | |
| { | |
| "in": "formData", | |
| "name": "file5", | |
| "type": "file" | |
| }, | |
| { | |
| "in": "formData", | |
| "name": "file6", | |
| "type": "file" | |
| }, | |
| { | |
| "in": "formData", | |
| "name": "file7", | |
| "type": "file" | |
| }, | |
| { | |
| "in": "formData", | |
| "name": "file8", | |
| "type": "file" | |
| }, | |
| { | |
| "in": "formData", | |
| "name": "file9", | |
| "type": "file" | |
| }, | |
| { | |
| "in": "formData", | |
| "name": "file", | |
| "required": true, | |
| "type": "file" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfBulkItemDtoOfString" | |
| } | |
| }, | |
| "207": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfBulkItemDtoOfString" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/ProcessSchedules": { | |
| "get": { | |
| "tags": [ | |
| "ProcessSchedules" | |
| ], | |
| "summary": "Gets the process schedules.", | |
| "description": "OAuth required scopes: OR.Jobs or OR.Jobs.Read.\n\nRequired permissions: Schedules.View.", | |
| "operationId": "ProcessSchedules_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfProcessScheduleDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "ProcessSchedules" | |
| ], | |
| "summary": "Creates a new process schedule.", | |
| "description": "OAuth required scopes: OR.Jobs or OR.Jobs.Write.\n\nRequired permissions: Schedules.Create.", | |
| "operationId": "ProcessSchedules_Post", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/ProcessScheduleDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Created", | |
| "schema": { | |
| "$ref": "#/definitions/ProcessScheduleDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/ProcessSchedules({key})": { | |
| "get": { | |
| "tags": [ | |
| "ProcessSchedules" | |
| ], | |
| "summary": "Gets a single process schedule based on its key.", | |
| "description": "OAuth required scopes: OR.Jobs or OR.Jobs.Read.\n\nRequired permissions: Schedules.View.", | |
| "operationId": "ProcessSchedules_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ProcessScheduleDto" | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "ProcessSchedules" | |
| ], | |
| "summary": "Edits a process schedule.", | |
| "description": "OAuth required scopes: OR.Jobs or OR.Jobs.Write.\n\nRequired permissions: Schedules.Edit.", | |
| "operationId": "ProcessSchedules_PutById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/ProcessScheduleDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "ProcessSchedules" | |
| ], | |
| "summary": "Deletes a process schedule.", | |
| "description": "OAuth required scopes: OR.Jobs or OR.Jobs.Write.\n\nRequired permissions: Schedules.Delete.", | |
| "operationId": "ProcessSchedules_DeleteById", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/ProcessSchedules({key})/UiPath.Server.Configuration.OData.Activate": { | |
| "post": { | |
| "tags": [ | |
| "ProcessSchedules" | |
| ], | |
| "summary": "Activates a process schedule associated with a queue", | |
| "description": "OAuth required scopes: OR.Jobs or OR.Jobs.Write.\n\nRequired permissions: Schedules.Edit.", | |
| "operationId": "ProcessSchedules_ActivateById", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Process Schedule was activated successfully" | |
| }, | |
| "404": { | |
| "description": "Process Schedule not found" | |
| }, | |
| "409": { | |
| "description": "Process Schedule cannot be activated" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/ProcessSchedules/UiPath.Server.Configuration.OData.GetRobotIdsForSchedule(key={key})": { | |
| "get": { | |
| "tags": [ | |
| "ProcessSchedules" | |
| ], | |
| "summary": "Returns a collection of all the ids of the robots associated to an schedule based on schedule Id.", | |
| "description": "OAuth required scopes: OR.Jobs or OR.Jobs.Read.\n\nRequired permissions: Schedules.View.", | |
| "operationId": "ProcessSchedules_GetRobotIdsForScheduleByKey", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "The Id of the schedule for which the robot ids are fetched.", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfInt64" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/ProcessSchedules/UiPath.Server.Configuration.OData.SetEnabled": { | |
| "post": { | |
| "tags": [ | |
| "ProcessSchedules" | |
| ], | |
| "summary": "Enables/disables a group of schedules.", | |
| "description": "OAuth required scopes: OR.Jobs or OR.Jobs.Write.\n\nRequired permissions: Schedules.Edit.", | |
| "operationId": "ProcessSchedules_SetEnabled", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "<para />Enabled - If true the schedules will be enabled, if false the schedules will be disabled.\r\n <para />ScheduleIds - The collection of ids of the affected schedules.", | |
| "schema": { | |
| "$ref": "#/definitions/ProcessSetEnabledRequest" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfBoolean" | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "schema": { | |
| "$ref": "#/definitions/ErrorResult" | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "schema": { | |
| "$ref": "#/definitions/ErrorResult" | |
| } | |
| }, | |
| "207": { | |
| "description": "Success", | |
| "schema": { | |
| "type": "object", | |
| "additionalProperties": { | |
| "$ref": "#/definitions/ErrorResult" | |
| } | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/ProcessSchedules/UiPath.Server.Configuration.OData.ValidateProcessSchedule": { | |
| "post": { | |
| "tags": [ | |
| "ProcessSchedules" | |
| ], | |
| "summary": "Validates the input which would be used to create a process schedule.", | |
| "description": "OAuth required scopes: OR.Jobs or OR.Jobs.Write.\n\nRequired permissions: Schedules.Create.", | |
| "operationId": "ProcessSchedules_ValidateProcessSchedule", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/ValidateProcessScheduleRequest" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ValidationResultDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/QueueDefinitions": { | |
| "get": { | |
| "tags": [ | |
| "QueueDefinitions" | |
| ], | |
| "summary": "Gets the list of queue definitions.", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Read.\n\nRequired permissions: Queues.View.", | |
| "operationId": "QueueDefinitions_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "mandatoryPermissions", | |
| "description": "If in a cross-folder scenario, these represent the additional permissions\r\n required in the folders the data is retrieved from; all permissions in this set must be met", | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "atLeastOnePermissions", | |
| "description": "If in a cross-folder scenario, these represent the additional permissions\r\n required in the folders the data is retrieved from; at least one permission in this set must be met", | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfQueueDefinitionDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "QueueDefinitions" | |
| ], | |
| "summary": "Creates a new queue.", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Write.\n\nRequired permissions: Queues.Create.", | |
| "operationId": "QueueDefinitions_Post", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/QueueDefinitionDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Created", | |
| "schema": { | |
| "$ref": "#/definitions/QueueDefinitionDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/QueueDefinitions({key})": { | |
| "get": { | |
| "tags": [ | |
| "QueueDefinitions" | |
| ], | |
| "summary": "Gets a single queue definition based on its Id.", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Read.\n\nRequired permissions: Queues.View.", | |
| "operationId": "QueueDefinitions_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/QueueDefinitionDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "QueueDefinitions" | |
| ], | |
| "summary": "Edits a queue.", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Write.\n\nRequired permissions: Queues.Edit.", | |
| "operationId": "QueueDefinitions_PutById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/QueueDefinitionDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "QueueDefinitions" | |
| ], | |
| "summary": "Deletes a queue based on its key.", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Write.\n\nRequired permissions: Queues.Delete.", | |
| "operationId": "QueueDefinitions_DeleteById", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Deleted" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/QueueDefinitions({key})/UiPathODataSvc.Export": { | |
| "post": { | |
| "tags": [ | |
| "QueueDefinitions" | |
| ], | |
| "summary": "Requests a CSV export of filtered items.", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Write.\n\nRequired permissions: Queues.View and Transactions.View.", | |
| "operationId": "QueueDefinitions_ExportById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ExportModel" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/QueueDefinitions({key})/UiPathODataSvc.GetJsonSchemaDefinition(jsonSchemaType='{jsonSchemaType}')": { | |
| "get": { | |
| "tags": [ | |
| "QueueDefinitions" | |
| ], | |
| "summary": "Gets a given queue item JSON schema as a .json file, based on queue definition id.", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Read.\n\nRequired permissions: Queues.Edit.", | |
| "operationId": "QueueDefinitions_GetJsonSchemaDefinitionByIdAndJsonschematype", | |
| "produces": [ | |
| "application/octet-stream" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "jsonSchemaType", | |
| "description": "Possible values: QueueSchemaType", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "format": "file", | |
| "type": "file" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/QueueDefinitions/UiPath.Server.Configuration.OData.GetByKey(identifier={identifier})": { | |
| "get": { | |
| "tags": [ | |
| "QueueDefinitions" | |
| ], | |
| "summary": "Gets a single queue definition by its GUID key.", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Read.\n\nRequired permissions: Queues.View.", | |
| "operationId": "QueueDefinitions_GetByKeyByIdentifier", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "identifier", | |
| "description": "", | |
| "required": true, | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/QueueDefinitionDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/QueueDefinitions/UiPath.Server.Configuration.OData.GetFoldersForQueue(id={id})": { | |
| "get": { | |
| "tags": [ | |
| "QueueDefinitions" | |
| ], | |
| "summary": "Get all accessible folders where the queue is shared, and the total count of folders where it is shared (including inaccessible folders).", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Read.\n\nRequires authentication.", | |
| "operationId": "QueueDefinitions_GetFoldersForQueueById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/AccessibleFoldersDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/QueueDefinitions/UiPath.Server.Configuration.OData.GetQueuesAcrossFolders": { | |
| "get": { | |
| "tags": [ | |
| "QueueDefinitions" | |
| ], | |
| "summary": "Get the queues from all the folders in which the current user has the Queues.View permission, except the ones in the excluded folder.", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Read.\n\nRequires authentication.", | |
| "operationId": "QueueDefinitions_GetQueuesAcrossFolders", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "excludeFolderId", | |
| "description": "", | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfQueueDefinitionDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/QueueDefinitions/UiPath.Server.Configuration.OData.ShareToFolders": { | |
| "post": { | |
| "tags": [ | |
| "QueueDefinitions" | |
| ], | |
| "summary": "Makes the queue visible in the specified folders.", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Write.\n\nRequires authentication.", | |
| "operationId": "QueueDefinitions_ShareToFolders", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "Object containing the ids of the queue definitions and the ids of the folders where they should be shared.", | |
| "schema": { | |
| "$ref": "#/definitions/QueueFoldersShareDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| }, | |
| "404": { | |
| "description": "A queue or one of the folders specified does not exist." | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/QueueItemComments": { | |
| "get": { | |
| "tags": [ | |
| "QueueItemComments" | |
| ], | |
| "summary": "Gets the QueueItemComments.", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Read.\n\nRequired permissions: Queues.View and Transactions.View.", | |
| "operationId": "QueueItemComments_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfQueueItemCommentDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "QueueItemComments" | |
| ], | |
| "summary": "Creates a QueueItemComment.", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Write.\n\nRequired permissions: Queues.View and Transactions.Edit.\n\nNote: If the CreationTime is passed in in the UiPath.Orchestrator.Application.Dto.Queues.QueueItemCommentDto it will be overriden with server UTC time.", | |
| "operationId": "QueueItemComments_Post", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/QueueItemCommentDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Created", | |
| "schema": { | |
| "$ref": "#/definitions/QueueItemCommentDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/QueueItemComments({key})": { | |
| "get": { | |
| "tags": [ | |
| "QueueItemComments" | |
| ], | |
| "summary": "Gets a QueueItemComment by Id.", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Read.\n\nRequired permissions: Queues.View and Transactions.View.", | |
| "operationId": "QueueItemComments_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/QueueItemCommentDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "QueueItemComments" | |
| ], | |
| "summary": "Updates a QueueItemComment", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Write.\n\nRequired permissions: Queues.View and Transactions.Edit.", | |
| "operationId": "QueueItemComments_PutById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/QueueItemCommentDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "QueueItemComments" | |
| ], | |
| "summary": "Deletes a QueueItemComment.", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Write.\n\nRequired permissions: Queues.View and Transactions.Edit.", | |
| "operationId": "QueueItemComments_DeleteById", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/QueueItemComments/UiPath.Server.Configuration.OData.GetQueueItemCommentsHistory(queueItemId={queueItemId})": { | |
| "get": { | |
| "tags": [ | |
| "QueueItemComments" | |
| ], | |
| "summary": "Returns a collection of Queue Item Comments associated to a Queue Item and all its related Queue Items.\r\nA Queue Item is related to another if it was created as a retry of a failed Queue Item. They also share the same Key.", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Read.\n\nRequired permissions: Queues.View and Transactions.View.", | |
| "operationId": "QueueItemComments_GetQueueItemCommentsHistoryByQueueitemid", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "queueItemId", | |
| "description": "The Id of the Queue Item for which the comment history is requested.", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfQueueItemCommentDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/QueueItemEvents": { | |
| "get": { | |
| "tags": [ | |
| "QueueItemEvents" | |
| ], | |
| "summary": "Gets the QueueItemEvents.", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Read.\n\nRequired permissions: Queues.View and Transactions.View.", | |
| "operationId": "QueueItemEvents_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfQueueItemEventDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/QueueItemEvents({key})": { | |
| "get": { | |
| "tags": [ | |
| "QueueItemEvents" | |
| ], | |
| "summary": "Gets a QueueItemEvent by Id.", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Read.\n\nRequired permissions: Queues.View and Transactions.View.", | |
| "operationId": "QueueItemEvents_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/QueueItemEventDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/QueueItemEvents/UiPath.Server.Configuration.OData.GetQueueItemEventsHistory(queueItemId={queueItemId})": { | |
| "get": { | |
| "tags": [ | |
| "QueueItemEvents" | |
| ], | |
| "summary": "Returns a collection of Queue Item Events associated to a Queue Item and all its related Queue Items.\r\nA Queue Item is related to another if it was created as a retry of a failed Queue Item. They also share the same Key.", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Read.\n\nRequired permissions: Queues.View and Transactions.View.", | |
| "operationId": "QueueItemEvents_GetQueueItemEventsHistoryByQueueitemid", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "queueItemId", | |
| "description": "The Id of the Queue Item for which the event history is requested.", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfQueueItemEventDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/QueueItems": { | |
| "get": { | |
| "tags": [ | |
| "QueueItems" | |
| ], | |
| "summary": "Gets a collection of queue items.", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Read.\n\nRequired permissions: Queues.View and Transactions.View.", | |
| "operationId": "QueueItems_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "mandatoryPermissions", | |
| "description": "If in a cross-folder scenario, these represent the additional permissions\r\n required in the folders the data is retrieved from; all permissions in this set must be met", | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "atLeastOnePermissions", | |
| "description": "If in a cross-folder scenario, these represent the additional permissions\r\n required in the folders the data is retrieved from; at least one permission in this set must be met", | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 100.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfQueueItemDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/QueueItems({key})": { | |
| "get": { | |
| "tags": [ | |
| "QueueItems" | |
| ], | |
| "summary": "Gets a queue item by Id.", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Read.\n\nRequired permissions: Queues.View and Transactions.View.", | |
| "operationId": "QueueItems_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/QueueItemDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "QueueItems" | |
| ], | |
| "summary": "Deletes a queue item by Id.", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Write.\n\nRequired permissions: Queues.View and Transactions.Delete.", | |
| "operationId": "QueueItems_DeleteById", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "QueueItems" | |
| ], | |
| "summary": "Updates the QueueItem properties with the new values provided.", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Write.\n\nRequired permissions: Queues.Edit and Transactions.Edit.\n\nOnly UiPath.Orchestrator.Application.Dto.Queues.QueueItemDto.Progress, UiPath.Orchestrator.Application.Dto.Queues.QueueItemDto.Priority, UiPath.Orchestrator.Application.Dto.Queues.QueueItemDto.DueDate, UiPath.Orchestrator.Application.Dto.Queues.QueueItemDto.DeferDate and UiPath.Orchestrator.Application.Dto.Queues.QueueItemDto.SpecificContent will be updated from given queueItemDto object.", | |
| "operationId": "QueueItems_PutById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/QueueItemDataDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Queue Item updated successfully." | |
| }, | |
| "404": { | |
| "description": "Queue Item does not exist." | |
| }, | |
| "409": { | |
| "description": "Conflict with Queue Item being updated." | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/QueueItems({key})/UiPath.Server.Configuration.OData.GetItemLastRetry": { | |
| "get": { | |
| "tags": [ | |
| "QueueItems" | |
| ], | |
| "summary": "Returns the last retry of a queue item.", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Read.\n\nRequired permissions: Queues.View and Transactions.View.", | |
| "operationId": "QueueItems_GetItemLastRetryById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/QueueItemDto" | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/QueueItems({key})/UiPathODataSvc.GetItemProcessingHistory": { | |
| "get": { | |
| "tags": [ | |
| "QueueItems" | |
| ], | |
| "summary": "Returns data about the processing history of the given queue item. Allows odata query options.", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Read.\n\nRequired permissions: Queues.View and Transactions.View.", | |
| "operationId": "QueueItems_GetItemProcessingHistoryById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfQueueItemDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/QueueItems({key})/UiPathODataSvc.SetTransactionProgress": { | |
| "post": { | |
| "tags": [ | |
| "QueueItems" | |
| ], | |
| "summary": "Updates the progress field of a queue item with the status 'In Progress'.", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Write.\n\nRequired permissions: Queues.View and Transactions.Edit.", | |
| "operationId": "QueueItems_SetTransactionProgressById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "<para />QueueItemId - The item's id.\r\n <para />Progress - The value for the Progress field.", | |
| "schema": { | |
| "$ref": "#/definitions/QueueSetTransactionProgressRequest" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/QueueItems/UiPath.Server.Configuration.OData.GetReviewers": { | |
| "get": { | |
| "tags": [ | |
| "QueueItems" | |
| ], | |
| "summary": "Returns a collection of users having the permission for Queue Items review. Allows odata query options.", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Read.\n\nRequired permissions: Queues.View and Transactions.Edit.", | |
| "operationId": "QueueItems_GetReviewers", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfSimpleUserDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/QueueItems/UiPathODataSvc.DeleteBulk": { | |
| "post": { | |
| "tags": [ | |
| "QueueItems" | |
| ], | |
| "summary": "Sets the given queue items' status to Deleted.", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Write.\n\nRequired permissions: Queues.View and Transactions.Delete.", | |
| "operationId": "QueueItems_DeleteBulk", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "QueueItems - The collection of ids of queue items to delete.", | |
| "schema": { | |
| "$ref": "#/definitions/QueueItemDeleteBulkRequest" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/BulkOperationResponseDtoOfInt64" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/QueueItems/UiPathODataSvc.GetItemLastRetryByKey(key={key})": { | |
| "get": { | |
| "tags": [ | |
| "QueueItems" | |
| ], | |
| "summary": "Returns the last retry of a queue item by uniqueKey.", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Read.\n\nRequired permissions: Queues.View and Transactions.View.", | |
| "operationId": "QueueItems_GetItemLastRetryByKey", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/QueueItemDto" | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/QueueItems/UiPathODataSvc.SetItemReviewer": { | |
| "post": { | |
| "tags": [ | |
| "QueueItems" | |
| ], | |
| "summary": "Sets the reviewer for multiple queue items", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Write.\n\nRequired permissions: Queues.View and Transactions.Edit.", | |
| "operationId": "QueueItems_SetItemReviewer", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "<para />UserId - The ID of the user to be set as the reviewer. If not set, the reviewer is cleared.\r\n <para />QueueItems - The collection of ids of queue items for which the reviewer is set.", | |
| "schema": { | |
| "$ref": "#/definitions/QueueSetItemReviewerRequest" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/BulkOperationResponseDtoOfInt64" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/QueueItems/UiPathODataSvc.SetItemReviewStatus": { | |
| "post": { | |
| "tags": [ | |
| "QueueItems" | |
| ], | |
| "summary": "Updates the review status of the specified queue items to an indicated state.", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Write.\n\nRequired permissions: Queues.View and Transactions.Edit.", | |
| "operationId": "QueueItems_SetItemReviewStatus", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "<para />QueueItems - The collection of ids of queue items for which the state is set.\r\n <para />Status - The new value for the review status.", | |
| "schema": { | |
| "$ref": "#/definitions/QueueSetItemReviewStatusRequest" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/BulkOperationResponseDtoOfInt64" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/QueueItems/UiPathODataSvc.UnsetItemReviewer": { | |
| "post": { | |
| "tags": [ | |
| "QueueItems" | |
| ], | |
| "summary": "Unsets the reviewer for multiple queue items", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Write.\n\nRequired permissions: Queues.View and Transactions.Edit.", | |
| "operationId": "QueueItems_UnsetItemReviewer", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "<para />QueueItems - The collection of ids of queue items for which the reviewer is unset.", | |
| "schema": { | |
| "$ref": "#/definitions/QueueUnsetItemReviewerRequest" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/BulkOperationResponseDtoOfInt64" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/QueueProcessingRecords/UiPathODataSvc.RetrieveLastDaysProcessingRecords(daysNo={daysNo},queueDefinitionId={queueDefinitionId})": { | |
| "get": { | |
| "tags": [ | |
| "QueueProcessingRecords" | |
| ], | |
| "summary": "Returns the computed processing status for a given queue in the last specified days.", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Read.\n\nRequired permissions: Queues.View and Transactions.View.", | |
| "operationId": "QueueProcessingRecords_RetrieveLastDaysProcessingRecordsByDaysnoAndQueuedefinitionid", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "daysNo", | |
| "description": "The number of days to go back from the present moment when calculating the report. If it is 0 the report will be computed for the last hour.", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "queueDefinitionId", | |
| "description": "The Id of the queue for which the report is computed.", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfQueueProcessingRecordDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/QueueProcessingRecords/UiPathODataSvc.RetrieveQueuesProcessingStatus": { | |
| "get": { | |
| "tags": [ | |
| "QueueProcessingRecords" | |
| ], | |
| "summary": "Returns the processing status for all queues. Allows odata query options.", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Read.\n\nRequired permissions: Queues.View.", | |
| "operationId": "QueueProcessingRecords_RetrieveQueuesProcessingStatus", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfQueueProcessingStatusDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/QueueRetention": { | |
| "get": { | |
| "tags": [ | |
| "QueueRetention" | |
| ], | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Read.\n\nRequired permissions: Queues.View.", | |
| "operationId": "QueueRetention_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfQueueRetentionSettingDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/QueueRetention({key})": { | |
| "get": { | |
| "tags": [ | |
| "QueueRetention" | |
| ], | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Read.\n\nRequired permissions: Queues.View.", | |
| "operationId": "QueueRetention_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "retentionType", | |
| "type": "string", | |
| "enum": [ | |
| "Final", | |
| "Stale" | |
| ], | |
| "x-ms-enum": { | |
| "name": "RetentionType", | |
| "modelAsString": false | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/QueueRetentionSettingDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "QueueRetention" | |
| ], | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Write.\n\nRequired permissions: Queues.Edit.", | |
| "operationId": "QueueRetention_PutById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "schema": { | |
| "$ref": "#/definitions/QueueRetentionSettingDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "QueueRetention" | |
| ], | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Write.\n\nRequired permissions: Queues.Edit.", | |
| "operationId": "QueueRetention_DeleteById", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Queues({key})/UiPathODataSvc.SetTransactionResult": { | |
| "post": { | |
| "tags": [ | |
| "Queues" | |
| ], | |
| "summary": "Sets the result of a transaction.", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Write.\n\nRequired permissions: Queues.View and Transactions.Edit.", | |
| "operationId": "Queues_SetTransactionResultById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "The id of the transaction", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/QueueSetTransactionResultRequest" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| }, | |
| "409": { | |
| "description": "Conflict" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Queues/UiPathODataSvc.AddQueueItem": { | |
| "post": { | |
| "tags": [ | |
| "Queues" | |
| ], | |
| "summary": "Adds a new queue item", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Write.\n\nRequired permissions: Queues.View and Transactions.Create.", | |
| "operationId": "Queues_AddQueueItem", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/AddQueueItemRequest" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Created", | |
| "schema": { | |
| "$ref": "#/definitions/QueueItemDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Queues/UiPathODataSvc.BulkAddQueueItems": { | |
| "post": { | |
| "tags": [ | |
| "Queues" | |
| ], | |
| "summary": "Bulk adds queue items", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Write.\n\nRequired permissions: Queues.View and Transactions.Create.", | |
| "operationId": "Queues_BulkAddQueueItems", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/BulkAddQueueItemsRequest" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/BulkOperationResponseDtoOfFailedQueueItemDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Queues/UiPathODataSvc.StartTransaction": { | |
| "post": { | |
| "tags": [ | |
| "Queues" | |
| ], | |
| "summary": "Starts a transaction", | |
| "description": "OAuth required scopes: OR.Queues or OR.Queues.Write.\n\nRequired permissions: Queues.View and Transactions.View and Transactions.Create and Transactions.Edit.", | |
| "operationId": "Queues_StartTransaction", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/QueuesStartTransactionRequest" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/QueueItemDto" | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/ReleaseRetention": { | |
| "get": { | |
| "tags": [ | |
| "ReleaseRetention" | |
| ], | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Read.\n\nRequired permissions: Processes.View.", | |
| "operationId": "ReleaseRetention_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfReleaseRetentionSettingDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/ReleaseRetention({key})": { | |
| "get": { | |
| "tags": [ | |
| "ReleaseRetention" | |
| ], | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Read.\n\nRequired permissions: Processes.View.", | |
| "operationId": "ReleaseRetention_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "retentionType", | |
| "type": "string", | |
| "enum": [ | |
| "Final", | |
| "Stale" | |
| ], | |
| "x-ms-enum": { | |
| "name": "RetentionType", | |
| "modelAsString": false | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ReleaseRetentionSettingDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "ReleaseRetention" | |
| ], | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Write.\n\nRequired permissions: Processes.Edit.", | |
| "operationId": "ReleaseRetention_PutById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "schema": { | |
| "$ref": "#/definitions/ReleaseRetentionSettingDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "ReleaseRetention" | |
| ], | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Write.\n\nRequired permissions: Processes.Edit.", | |
| "operationId": "ReleaseRetention_DeleteById", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Releases": { | |
| "get": { | |
| "tags": [ | |
| "Releases" | |
| ], | |
| "summary": "Gets multiple releases.", | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Read.\n\nRequired permissions: Processes.View.", | |
| "operationId": "Releases_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "mandatoryPermissions", | |
| "description": "If in a cross-folder scenario, these represent the additional permissions\r\n required in the folders the data is retrieved from; all permissions in this set must be met", | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "atLeastOnePermissions", | |
| "description": "If in a cross-folder scenario, these represent the additional permissions\r\n required in the folders the data is retrieved from; at least one permission in this set must be met", | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfReleaseDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "Releases" | |
| ], | |
| "summary": "Creates a new release.", | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Write.\n\nRequired permissions: (Processes.Create) and (RemoteControl.Create - Required when creating a process with live streaming enabled.).", | |
| "operationId": "Releases_Post", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/ReleaseDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Created", | |
| "schema": { | |
| "$ref": "#/definitions/ReleaseDto" | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Releases({key})": { | |
| "get": { | |
| "tags": [ | |
| "Releases" | |
| ], | |
| "summary": "Gets a release by id.", | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Read.\n\nRequired permissions: Processes.View.", | |
| "operationId": "Releases_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ReleaseDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "Releases" | |
| ], | |
| "summary": "Partially updates a release.", | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Write.\n\nRequired permissions: (Processes.Edit) and (RemoteControl.Create - Required when changing the live streaming configuration.).", | |
| "operationId": "Releases_PatchById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/ReleaseDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "Releases" | |
| ], | |
| "summary": "Edits a release.", | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Write.\n\nRequired permissions: (Processes.Edit) and (RemoteControl.Create - Required when changing the live streaming configuration.).", | |
| "operationId": "Releases_PutById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/ReleaseDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Releases" | |
| ], | |
| "summary": "Deletes a release.", | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Write.\n\nRequired permissions: Processes.Delete.", | |
| "operationId": "Releases_DeleteById", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Releases({key})/UiPath.Server.Configuration.OData.RollbackToPreviousReleaseVersion": { | |
| "post": { | |
| "tags": [ | |
| "Releases" | |
| ], | |
| "summary": "Reverts the package versions for the given release to the last version it had before the current one.", | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Write.\n\nRequired permissions: Processes.Edit.", | |
| "operationId": "Releases_RollbackToPreviousReleaseVersionById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "mergePackageTags", | |
| "description": "", | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfInt64" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Releases({key})/UiPath.Server.Configuration.OData.UpdateToLatestPackageVersion": { | |
| "post": { | |
| "tags": [ | |
| "Releases" | |
| ], | |
| "summary": "Updates the package version for the given release to the latest available.", | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Write.\n\nRequired permissions: Processes.Edit.", | |
| "operationId": "Releases_UpdateToLatestPackageVersionById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "mergePackageTags", | |
| "description": "Merge process tags with the new package version tags", | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfInt64" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Releases({key})/UiPath.Server.Configuration.OData.UpdateToSpecificPackageVersion": { | |
| "post": { | |
| "tags": [ | |
| "Releases" | |
| ], | |
| "summary": "Updates the package version for the given release.", | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Write.\n\nRequired permissions: Processes.Edit.", | |
| "operationId": "Releases_UpdateToSpecificPackageVersionById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "PackageVersion - The new package version.", | |
| "schema": { | |
| "$ref": "#/definitions/ReleasesUpdateToSpecificPackageVersionRequest" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfInt64" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Releases/UiPath.Server.Configuration.OData.RollbackToPreviousReleaseVersionByKey(identifier={identifier})": { | |
| "post": { | |
| "tags": [ | |
| "Releases" | |
| ], | |
| "summary": "Reverts the package versions for the given release to the last version it had before the current one.", | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Write.\n\nRequired permissions: Processes.Edit.", | |
| "operationId": "Releases_RollbackToPreviousReleaseVersionByKeyByIdentifier", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "identifier", | |
| "description": "", | |
| "required": true, | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "mergePackageTags", | |
| "description": "", | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfGuid" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Releases/UiPath.Server.Configuration.OData.UpdateByKey": { | |
| "post": { | |
| "tags": [ | |
| "Releases" | |
| ], | |
| "summary": "Updates the package entry point for the given release.", | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Write.\n\nRequired permissions: Processes.Edit.", | |
| "operationId": "Releases_UpdateByKey", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/ReleasesUpdateByKeyRequest" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| }, | |
| "400": { | |
| "description": "Bad Request" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Releases/UiPath.Server.Configuration.OData.UpdateToLatestPackageVersionBulk": { | |
| "post": { | |
| "tags": [ | |
| "Releases" | |
| ], | |
| "summary": "Updates the package versions for the given releases to the latest available.", | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Write.\n\nRequired permissions: Processes.Edit.", | |
| "operationId": "Releases_UpdateToLatestPackageVersionBulk", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/ReleasesUpdateToLatestPackageVersionBulkRequest" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/BulkOperationResponseDtoOfInt64" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Releases/UiPath.Server.Configuration.OData.UpdateToLatestPackageVersionBulkByKey": { | |
| "post": { | |
| "tags": [ | |
| "Releases" | |
| ], | |
| "summary": "Updates the package versions for the given releases to the latest available.", | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Write.\n\nRequired permissions: Processes.Edit.", | |
| "operationId": "Releases_UpdateToLatestPackageVersionBulkByKey", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/ReleasesUpdateToLatestPackageVersionBulkRequestByKey" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/BulkOperationResponseDtoOfGuid" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Releases/UiPath.Server.Configuration.OData.UpdateToLatestPackageVersionByKey(identifier={identifier})": { | |
| "post": { | |
| "tags": [ | |
| "Releases" | |
| ], | |
| "summary": "Updates the package version for the given release to the latest available.", | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Write.\n\nRequired permissions: Processes.Edit.", | |
| "operationId": "Releases_UpdateToLatestPackageVersionByKeyByIdentifier", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "identifier", | |
| "description": "", | |
| "required": true, | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "mergePackageTags", | |
| "description": "Merge process tags with the new package version tags", | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfGuid" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Releases/UiPath.Server.Configuration.OData.UpdateToSpecificPackageVersionByKey(identifier={identifier})": { | |
| "post": { | |
| "tags": [ | |
| "Releases" | |
| ], | |
| "summary": "Updates the package version for the given release by its GUID key.", | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Write.\n\nRequired permissions: Processes.Edit.", | |
| "operationId": "Releases_UpdateToSpecificPackageVersionByKeyByIdentifier", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "identifier", | |
| "description": "", | |
| "required": true, | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "PackageVersion - The new package version.", | |
| "schema": { | |
| "$ref": "#/definitions/ReleasesUpdateToSpecificPackageVersionRequest" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfGuid" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/RobotLogs": { | |
| "get": { | |
| "tags": [ | |
| "RobotLogs" | |
| ], | |
| "summary": "Gets the robot logs.", | |
| "description": "OAuth required scopes: OR.Monitoring or OR.Monitoring.Read.\n\nRequired permissions: Logs.View.", | |
| "operationId": "RobotLogs_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfLogDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/RobotLogs/UiPath.Server.Configuration.OData.Export": { | |
| "post": { | |
| "tags": [ | |
| "RobotLogs" | |
| ], | |
| "summary": "Requests a CSV export of filtered items.", | |
| "description": "OAuth required scopes: OR.Monitoring or OR.Monitoring.Write.\n\nRequired permissions: Logs.View.", | |
| "operationId": "RobotLogs_Export", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ExportModel" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/RobotLogs/UiPath.Server.Configuration.OData.GetTotalCount": { | |
| "get": { | |
| "tags": [ | |
| "RobotLogs" | |
| ], | |
| "summary": "Gets the total count of robot logs.\r\nThis might be different than the size of the count returned by GetRobotLogs which\r\nis limited by the max_result_window parameter for an Elasticsearch source.", | |
| "description": "OAuth required scopes: OR.Monitoring or OR.Monitoring.Read.\n\nRequired permissions: Logs.View.", | |
| "operationId": "RobotLogs_GetTotalCount", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfInt64" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Robots": { | |
| "get": { | |
| "tags": [ | |
| "Robots" | |
| ], | |
| "summary": "Gets robots.", | |
| "description": "OAuth required scopes: OR.Robots or OR.Robots.Read.\n\nRequired permissions: Robots.View.", | |
| "operationId": "Robots_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfRobotDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "Robots" | |
| ], | |
| "summary": "Creates a new robot.", | |
| "description": "OAuth required scopes: OR.Robots or OR.Robots.Write.\n\nRequired permissions: (Robots.Create - Floating Robot) and (Robots.Create and Machines.View - Standard Robot).", | |
| "operationId": "Robots_Post", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/RobotDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Created", | |
| "schema": { | |
| "$ref": "#/definitions/RobotDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Robots({key})": { | |
| "get": { | |
| "tags": [ | |
| "Robots" | |
| ], | |
| "summary": "Gets a single robot based on its key.", | |
| "description": "OAuth required scopes: OR.Robots or OR.Robots.Read.\n\nRequired permissions: Robots.View.", | |
| "operationId": "Robots_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/RobotDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "Robots" | |
| ], | |
| "summary": "Edits a robot based on its key.", | |
| "description": "OAuth required scopes: OR.Robots or OR.Robots.Write.\n\nRequired permissions: Robots.Edit.", | |
| "operationId": "Robots_PutById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/RobotDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "Robots" | |
| ], | |
| "summary": "Partially updates a robot.", | |
| "description": "OAuth required scopes: OR.Robots or OR.Robots.Write.\n\nRequired permissions: Robots.Edit.", | |
| "operationId": "Robots_PatchById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/RobotDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Robots" | |
| ], | |
| "summary": "Deletes a robot based on its key.", | |
| "description": "OAuth required scopes: OR.Robots or OR.Robots.Write.\n\nRequired permissions: Robots.Delete.", | |
| "operationId": "Robots_DeleteById", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Robots/UiPath.Server.Configuration.OData.ConvertToFloating": { | |
| "post": { | |
| "tags": [ | |
| "Robots" | |
| ], | |
| "summary": "Convert a Standard Attended Robot to a Floating Robot.", | |
| "description": "OAuth required scopes: OR.Robots or OR.Robots.Write.\n\nRequired permissions: Robots.Edit.", | |
| "operationId": "Robots_ConvertToFloating", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/RobotsConvertToFloatingRequest" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| }, | |
| "400": { | |
| "description": "Invalid arguments" | |
| }, | |
| "409": { | |
| "description": "Conflict" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Robots/UiPath.Server.Configuration.OData.DeleteBulk": { | |
| "post": { | |
| "tags": [ | |
| "Robots" | |
| ], | |
| "summary": "Deletes multiple robots based on their keys.", | |
| "description": "OAuth required scopes: OR.Robots or OR.Robots.Write.\n\nRequired permissions: Robots.Delete.", | |
| "operationId": "Robots_DeleteBulk", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/RobotDeleteBulkRequest" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| }, | |
| "400": { | |
| "description": "Empty robotIds collection in payload" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Robots/UiPath.Server.Configuration.OData.FindAllAcrossFolders": { | |
| "get": { | |
| "tags": [ | |
| "Robots" | |
| ], | |
| "summary": "Get robots across all accessible folders.", | |
| "description": "OAuth required scopes: OR.Robots or OR.Robots.Read.\n\nRequired permissions: Robots.View or Users.View or Machines.Create or Machines.Edit.", | |
| "operationId": "Robots_FindAllAcrossFolders", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfExtendedRobotDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Robots/UiPath.Server.Configuration.OData.GetConfiguredRobots": { | |
| "get": { | |
| "tags": [ | |
| "Robots" | |
| ], | |
| "summary": "Gets robots autoprovisioned from users", | |
| "description": "OAuth required scopes: OR.Robots or OR.Robots.Read.\n\nRequired permissions: (Users.View - Required only when the robot's user is expanded) and (Robots.View).", | |
| "operationId": "Robots_GetConfiguredRobots", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfExtendedRobotDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Robots/UiPath.Server.Configuration.OData.GetFolderRobots(folderId={folderId},machineId={machineId})": { | |
| "get": { | |
| "tags": [ | |
| "Robots" | |
| ], | |
| "summary": "Get folder robots", | |
| "description": "OAuth required scopes: OR.Robots or OR.Robots.Read.\n\nRequired permissions: (SubFolders.View or Units.View or Jobs.Create).", | |
| "operationId": "Robots_GetFolderRobotsByFolderidAndMachineid", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "folderId", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "path", | |
| "name": "machineId", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfExtendedRobotDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Robots/UiPath.Server.Configuration.OData.GetMachineNameToLicenseKeyMappings": { | |
| "get": { | |
| "tags": [ | |
| "Robots" | |
| ], | |
| "summary": "Gets machine name to license key mapping.", | |
| "description": "OAuth required scopes: OR.Robots or OR.Robots.Read.\n\nRequired permissions: Robots.Create and Machines.View.", | |
| "operationId": "Robots_GetMachineNameToLicenseKeyMappings", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfKeyValuePairOfStringString" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Robots/UiPath.Server.Configuration.OData.GetRobotsForProcess(processId='{processId}')": { | |
| "get": { | |
| "tags": [ | |
| "Robots" | |
| ], | |
| "summary": "Returns a collection of all robots that can execute the process with the provided Id.", | |
| "description": "OAuth required scopes: OR.Robots or OR.Robots.Read.\n\nRequired permissions: Robots.View and Environments.View and Processes.View.", | |
| "operationId": "Robots_GetRobotsForProcessByProcessid", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "processId", | |
| "description": "The Id of the process for which the robots are fetched.", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfRobotDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Robots/UiPath.Server.Configuration.OData.GetRobotsFromFolder(folderId={folderId})": { | |
| "get": { | |
| "tags": [ | |
| "Robots" | |
| ], | |
| "summary": "Gets all robots from a folder", | |
| "description": "OAuth required scopes: OR.Robots or OR.Robots.Read.\n\nRequired permissions: (SubFolders.View or Units.View or Jobs.Create or Users.View).", | |
| "operationId": "Robots_GetRobotsFromFolderByFolderid", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "folderId", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "machineId", | |
| "description": "", | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfRobotsFromFolderModel" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Robots/UiPath.Server.Configuration.OData.GetUsernames": { | |
| "get": { | |
| "tags": [ | |
| "Robots" | |
| ], | |
| "summary": "Gets usernames.", | |
| "description": "OAuth required scopes: OR.Robots or OR.Robots.Read.\n\nRequired permissions: Robots.View.", | |
| "operationId": "Robots_GetUsernames", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfString" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Robots/UiPath.Server.Configuration.OData.ToggleEnabledStatus": { | |
| "post": { | |
| "tags": [ | |
| "Robots" | |
| ], | |
| "summary": "Toggles the status of the robots (enabled/disabled)", | |
| "description": "OAuth required scopes: OR.Robots or OR.Robots.Write.\n\nRequired permissions: Robots.Edit.", | |
| "operationId": "Robots_ToggleEnabledStatus", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "<para /> disabled - If true the robots will be enabled, if false the robots will be disabled.\r\n <para /> robotIds - The collection of ids of the affected robots.", | |
| "schema": { | |
| "$ref": "#/definitions/RobotsToggleEnabledStatusRequest" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Roles": { | |
| "get": { | |
| "tags": [ | |
| "Roles" | |
| ], | |
| "summary": "Gets roles.", | |
| "description": "OAuth required scopes: OR.Users or OR.Users.Read.\n\nRequired permissions: Roles.View or Units.Edit or SubFolders.Edit.", | |
| "operationId": "Roles_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfRoleDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "Roles" | |
| ], | |
| "summary": "Creates a new role - Creating mixed roles will not be supported in 21.10", | |
| "description": "OAuth required scopes: OR.Users or OR.Users.Write.\n\nRequired permissions: Roles.Create.", | |
| "operationId": "Roles_Post", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/RoleDto" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Created", | |
| "schema": { | |
| "$ref": "#/definitions/RoleDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Roles({key})": { | |
| "get": { | |
| "tags": [ | |
| "Roles" | |
| ], | |
| "summary": "Gets role based on its id.", | |
| "description": "OAuth required scopes: OR.Users or OR.Users.Read.\n\nRequired permissions: Roles.View.", | |
| "operationId": "Roles_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/RoleDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "Roles" | |
| ], | |
| "summary": "Edits a role.", | |
| "description": "OAuth required scopes: OR.Users or OR.Users.Write.\n\nRequired permissions: Roles.Edit.", | |
| "operationId": "Roles_PutById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/RoleDto" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Roles" | |
| ], | |
| "summary": "Deletes a role.", | |
| "description": "OAuth required scopes: OR.Users or OR.Users.Write.\n\nRequired permissions: Roles.Delete.", | |
| "operationId": "Roles_DeleteById", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Roles({key})/UiPath.Server.Configuration.OData.SetUsers": { | |
| "post": { | |
| "tags": [ | |
| "Roles" | |
| ], | |
| "summary": "Associates a group of users with and dissociates another group of users from the given role.", | |
| "description": "OAuth required scopes: OR.Users or OR.Users.Write.\n\nRequired permissions: Roles.Edit and Users.View.", | |
| "operationId": "Roles_SetUsersById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "The role id.", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "<para />addedUserIds - The id of the users to be associated with the role.\r\n <para />removedUserIds - The id of the users to be dissociated from the role.", | |
| "schema": { | |
| "$ref": "#/definitions/SetUsersRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Nothing returned" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Roles/UiPath.Server.Configuration.OData.GetUserIdsForRole(key={key})": { | |
| "get": { | |
| "tags": [ | |
| "Roles" | |
| ], | |
| "summary": "Returns a collection of all the ids of the users associated to a role based on role Id.", | |
| "description": "OAuth required scopes: OR.Users or OR.Users.Read.\n\nRequired permissions: Roles.View or Users.View.", | |
| "operationId": "Roles_GetUserIdsForRoleByKey", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "The Id of the role for which the robot ids are fetched.", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfInt64" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Roles/UiPath.Server.Configuration.OData.GetUsersForRole(key={key})": { | |
| "get": { | |
| "tags": [ | |
| "Roles" | |
| ], | |
| "summary": "Returns a collection of all users and, if no other sorting is provided, will place first those associated to a role.Allows odata query options.", | |
| "description": "OAuth required scopes: OR.Users or OR.Users.Read.\n\nRequired permissions: Roles.View and Users.View.", | |
| "operationId": "Roles_GetUsersForRoleByKey", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "The Id of the role for which the associated users are placed first.", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfUserDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Sessions": { | |
| "get": { | |
| "tags": [ | |
| "Sessions" | |
| ], | |
| "summary": "Gets the sessions for the current folder.", | |
| "description": "OAuth required scopes: OR.Robots or OR.Robots.Read.\n\nRequired permissions: Robots.View.", | |
| "operationId": "Sessions_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfSessionDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Sessions({key})/UiPath.Server.Configuration.OData.ToggleMachineSessionDebugMode": { | |
| "post": { | |
| "tags": [ | |
| "Sessions" | |
| ], | |
| "summary": "Toggles the debug mode for the specified machine session", | |
| "description": "OAuth required scopes: OR.Robots or OR.Robots.Write.\n\nRequired permissions: Robots.Edit.", | |
| "operationId": "Sessions_ToggleMachineSessionDebugModeById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/SessionsToggleMachineSessionDebugModeRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| }, | |
| "400": { | |
| "description": "Bad Request" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Sessions/UiPath.Server.Configuration.OData.DeleteInactiveUnattendedSessions": { | |
| "post": { | |
| "tags": [ | |
| "Sessions" | |
| ], | |
| "summary": "Deletes disconnected or unresponsive sessions", | |
| "description": "OAuth required scopes: OR.Robots or OR.Robots.Write.\n\nRequired permissions: Robots.Delete.", | |
| "operationId": "Sessions_DeleteInactiveUnattendedSessions", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/DeleteInactiveSessionsParameters" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Sessions/UiPath.Server.Configuration.OData.GetGlobalSessions": { | |
| "get": { | |
| "tags": [ | |
| "Sessions" | |
| ], | |
| "summary": "Gets all the tenant sessions.", | |
| "description": "OAuth required scopes: OR.Robots or OR.Robots.Read.\n\nRequired permissions: (Robots.View and Users.View - Classic and modern robot sessions are returned.) and (Users.View or Machines.Create or Machines.Edit - Modern robot sessions are returned. Users.View is required only when the robot is expanded) and (Robots.View - Classic robot sessions are returned. Users.View is required only when the robot is expanded).", | |
| "operationId": "Sessions_GetGlobalSessions", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfSessionDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Sessions/UiPath.Server.Configuration.OData.GetMachineSessionRuntimes": { | |
| "get": { | |
| "tags": [ | |
| "Sessions" | |
| ], | |
| "summary": "Gets machine runtime sessions", | |
| "description": "OAuth required scopes: OR.Robots or OR.Robots.Read.\n\nRequired permissions: Machines.View.", | |
| "operationId": "Sessions_GetMachineSessionRuntimes", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "runtimeType", | |
| "description": "", | |
| "type": "string", | |
| "enum": [ | |
| "NonProduction", | |
| "Attended", | |
| "Unattended", | |
| "Development", | |
| "Studio", | |
| "RpaDeveloper", | |
| "StudioX", | |
| "CitizenDeveloper", | |
| "Headless", | |
| "StudioPro", | |
| "RpaDeveloperPro", | |
| "TestAutomation", | |
| "AutomationCloud", | |
| "Serverless", | |
| "AutomationKit", | |
| "ServerlessTestAutomation", | |
| "AutomationCloudTestAutomation", | |
| "AttendedStudioWeb", | |
| "Hosting", | |
| "AssistantWeb", | |
| "ProcessOrchestration", | |
| "AgentService", | |
| "AppTest", | |
| "PerformanceTest", | |
| "BusinessRule", | |
| "CaseManagement" | |
| ], | |
| "x-ms-enum": { | |
| "name": "RobotType", | |
| "modelAsString": false | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfMachineSessionRuntimeDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Sessions/UiPath.Server.Configuration.OData.GetMachineSessionRuntimesByFolderId(folderId={folderId})": { | |
| "get": { | |
| "tags": [ | |
| "Sessions" | |
| ], | |
| "summary": "Gets machine runtime sessions by folder id", | |
| "description": "OAuth required scopes: OR.Robots or OR.Robots.Read.\n\nRequired permissions: (Machines.View or Jobs.Create).", | |
| "operationId": "Sessions_GetMachineSessionRuntimesByFolderId", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "folderId", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "robotId", | |
| "description": "", | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "runtimeType", | |
| "description": "", | |
| "type": "string", | |
| "enum": [ | |
| "NonProduction", | |
| "Attended", | |
| "Unattended", | |
| "Development", | |
| "Studio", | |
| "RpaDeveloper", | |
| "StudioX", | |
| "CitizenDeveloper", | |
| "Headless", | |
| "StudioPro", | |
| "RpaDeveloperPro", | |
| "TestAutomation", | |
| "AutomationCloud", | |
| "Serverless", | |
| "AutomationKit", | |
| "ServerlessTestAutomation", | |
| "AutomationCloudTestAutomation", | |
| "AttendedStudioWeb", | |
| "Hosting", | |
| "AssistantWeb", | |
| "ProcessOrchestration", | |
| "AgentService", | |
| "AppTest", | |
| "PerformanceTest", | |
| "BusinessRule", | |
| "CaseManagement" | |
| ], | |
| "x-ms-enum": { | |
| "name": "RobotType", | |
| "modelAsString": false | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfMachineSessionRuntimeDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Sessions/UiPath.Server.Configuration.OData.GetMachineSessions(key={key})": { | |
| "get": { | |
| "tags": [ | |
| "Sessions" | |
| ], | |
| "summary": "Get sessions for a machine", | |
| "description": "OAuth required scopes: OR.Robots or OR.Robots.Read.\n\nRequired permissions: Machines.View.", | |
| "operationId": "Sessions_GetMachineSessionsByKey", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfMachineSessionDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Sessions/UiPath.Server.Configuration.OData.GetUsernames": { | |
| "get": { | |
| "tags": [ | |
| "Sessions" | |
| ], | |
| "summary": "Gets usernames.", | |
| "description": "OAuth required scopes: OR.Robots or OR.Robots.Read.\n\nRequired permissions: Robots.View or Users.View.", | |
| "operationId": "Sessions_GetUsernames", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfString" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Sessions/UiPath.Server.Configuration.OData.SetMaintenanceMode": { | |
| "post": { | |
| "tags": [ | |
| "Sessions" | |
| ], | |
| "summary": "Sets the execution capabilities for a specified host", | |
| "description": "OAuth required scopes: OR.Robots or OR.Robots.Write.\n\nRequired permissions: Robots.Edit.", | |
| "operationId": "Sessions_SetMaintenanceMode", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/SessionMaintenanceModeParameters" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Settings": { | |
| "get": { | |
| "tags": [ | |
| "Settings" | |
| ], | |
| "summary": "Gets the settings.", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Read.\n\nRequired permissions: Settings.View.", | |
| "operationId": "Settings_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfSettingsDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Settings('{key}')": { | |
| "get": { | |
| "tags": [ | |
| "Settings" | |
| ], | |
| "summary": "Gets a settings value based on its key.", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Read.\n\nRequired permissions: Settings.View.", | |
| "operationId": "Settings_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfString" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "Settings" | |
| ], | |
| "summary": "Edits a setting.", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Write.\n\nRequired permissions: Settings.Edit.", | |
| "operationId": "Settings_PutById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/SettingsDto" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Settings/UiPath.Server.Configuration.OData.DeleteBulk": { | |
| "post": { | |
| "tags": [ | |
| "Settings" | |
| ], | |
| "summary": "Deletes values for the specified settings in the Tenant scope.", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Write.\n\nRequired permissions: Settings.Delete.", | |
| "operationId": "Settings_DeleteBulk", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "Settings - The collection of settings to be deleted.", | |
| "schema": { | |
| "$ref": "#/definitions/SettingsDeleteBulkRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Settings/UiPath.Server.Configuration.OData.GetActivitySettings": { | |
| "get": { | |
| "tags": [ | |
| "Settings" | |
| ], | |
| "summary": "Returns Orchestrator settings used by activities", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Read.\n\nRequires authentication.", | |
| "operationId": "Settings_GetActivitySettings", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ActivitySettingsDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Settings/UiPath.Server.Configuration.OData.GetAuthenticationSettings": { | |
| "get": { | |
| "tags": [ | |
| "Settings" | |
| ], | |
| "summary": "Gets the authentication settings", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Read.", | |
| "operationId": "Settings_GetAuthenticationSettings", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ResponseDictionaryDto" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/odata/Settings/UiPath.Server.Configuration.OData.GetCalendar": { | |
| "get": { | |
| "tags": [ | |
| "Settings" | |
| ], | |
| "summary": "Gets custom calendar, with excluded dates in UTC, for current tenant", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Read.\n\nRequired permissions: Settings.View.\nDEPRECATED: \nThis API is deprecated. Please do not use it any longer. Use /odata/Calendars instead.\nPlease refer to https://docs.uipath.com/orchestrator/reference", | |
| "operationId": "Settings_GetCalendar", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/CalendarDto" | |
| } | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Settings/UiPath.Server.Configuration.OData.GetExecutionSettingsConfiguration(scope={scope})": { | |
| "get": { | |
| "tags": [ | |
| "Settings" | |
| ], | |
| "summary": "Gets the execution settings configuration (display name, value type, etc.).\r\nIf scope is 0 (Global), the default values will be the initial ones. If scope is 1 (Robot), then\r\nthe default values will be the actual values set globally.\r\ne.g., Resolution width\r\nAssume it was set globally to 720.\r\nThen within the config returned by this function, the default value for this setting will be:\r\n- 0 for scope = 0 and\r\n- 720 for scope = 1.", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Read.\n\nRequired permissions: Settings.Edit or Robots.Create or Robots.Edit.", | |
| "operationId": "Settings_GetExecutionSettingsConfigurationByScope", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "scope", | |
| "description": "Scope of the configuration; 0 for Global, 1 for Robot", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ExecutionSettingsConfiguration" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Settings/UiPath.Server.Configuration.OData.GetLanguages": { | |
| "get": { | |
| "tags": [ | |
| "Settings" | |
| ], | |
| "summary": "Gets supported languages", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Read.", | |
| "operationId": "Settings_GetLanguages", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ListResultDtoOfLanguageInfo" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/odata/Settings/UiPath.Server.Configuration.OData.GetLicense": { | |
| "get": { | |
| "tags": [ | |
| "Settings" | |
| ], | |
| "summary": "Retrieves the current license information.", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Read.\n\nRequires authentication.", | |
| "operationId": "Settings_GetLicense", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/LicenseDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Settings/UiPath.Server.Configuration.OData.GetSecureStoreConfiguration(storeTypeName='{storeTypeName}')": { | |
| "get": { | |
| "tags": [ | |
| "Settings" | |
| ], | |
| "summary": "Gets the configuration format for a Secure store", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Read.\n\nRequired permissions: Settings.View.", | |
| "operationId": "Settings_GetSecureStoreConfigurationByStoretypename", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "storeTypeName", | |
| "description": "name of the secure store type", | |
| "required": true, | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "proxyId", | |
| "description": "id of the hosted credential store", | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfConfigurationEntry" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Settings/UiPath.Server.Configuration.OData.GetTimezones": { | |
| "get": { | |
| "tags": [ | |
| "Settings" | |
| ], | |
| "summary": "Gets timezones.", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Read.", | |
| "operationId": "Settings_GetTimezones", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ListResultDtoOfNameValueDto" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/odata/Settings/UiPath.Server.Configuration.OData.GetUpdateSettings": { | |
| "get": { | |
| "tags": [ | |
| "Settings" | |
| ], | |
| "summary": "Gets the update settings", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Read.", | |
| "operationId": "Settings_GetUpdateSettings", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/UpdateSettingsDto" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/odata/Settings/UiPath.Server.Configuration.OData.GetWebSettings": { | |
| "get": { | |
| "tags": [ | |
| "Settings" | |
| ], | |
| "summary": "Returns a collection of key value pairs representing settings used by Orchestrator web client.", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Read.\n\nRequires authentication.", | |
| "operationId": "Settings_GetWebSettings", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ResponseDictionaryDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Settings/UiPath.Server.Configuration.OData.SetCalendar": { | |
| "post": { | |
| "tags": [ | |
| "Settings" | |
| ], | |
| "summary": "Sets custom calendar, with excluded dates in UTC, for current tenant", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Write.\n\nRequired permissions: Settings.Edit.\nDEPRECATED: \nThis API is deprecated. Please do not use it any longer. Use /odata/Calendars instead.\nPlease refer to https://docs.uipath.com/orchestrator/reference", | |
| "operationId": "Settings_SetCalendar", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/CalendarDto" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| }, | |
| "deprecated": true, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Settings/UiPath.Server.Configuration.OData.UpdateBulk": { | |
| "post": { | |
| "tags": [ | |
| "Settings" | |
| ], | |
| "summary": "Updates the current settings.", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Write.\n\nRequired permissions: Settings.Edit.", | |
| "operationId": "Settings_UpdateBulk", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "Settings - The collection of settings to be updated.", | |
| "schema": { | |
| "$ref": "#/definitions/SettingsUpdateBulkRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Settings/UiPath.Server.Configuration.OData.UpdateUserSetting": { | |
| "post": { | |
| "tags": [ | |
| "Settings" | |
| ], | |
| "summary": "Edits a user setting.", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Write.\n\nRequires authentication.", | |
| "operationId": "Settings_UpdateUserSetting", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/UpdateUserSettingRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Settings/UiPath.Server.Configuration.OData.VerifySmtpSetting": { | |
| "post": { | |
| "tags": [ | |
| "Settings" | |
| ], | |
| "summary": "Verify whether the given SMTP settings are correct or not by sending an email to a recipient.", | |
| "description": "OAuth required scopes: OR.Settings or OR.Settings.Write.\n\nRequired permissions: Settings.Edit.", | |
| "operationId": "Settings_VerifySmtpSetting", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "SMTP setting parameters", | |
| "schema": { | |
| "$ref": "#/definitions/VerifySmtpSettingRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| }, | |
| "400": { | |
| "description": "Bad Request" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/TaskActivities/UiPath.Server.Configuration.OData.GetByTaskId(taskId={taskId})": { | |
| "get": { | |
| "tags": [ | |
| "TaskActivities" | |
| ], | |
| "summary": "Gets Task Activities for a Task", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Read.\n\nRequired permissions: Tasks.View.", | |
| "operationId": "TaskActivities_GetByTaskId", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "taskId", | |
| "description": "Id of task", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfTaskActivityDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/TaskCatalogs": { | |
| "get": { | |
| "tags": [ | |
| "TaskCatalogs" | |
| ], | |
| "summary": "Gets Task Catalog objects with the given OData queries.", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Read.\n\nRequired permissions: TaskCatalogs.View.", | |
| "operationId": "TaskCatalogs_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfTaskCatalogDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/TaskCatalogs({key})": { | |
| "get": { | |
| "tags": [ | |
| "TaskCatalogs" | |
| ], | |
| "summary": "Gets a Task Catalog item by Id.", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Read.\n\nRequired permissions: TaskCatalogs.View.", | |
| "operationId": "TaskCatalogs_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "id of the object", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/TaskCatalogDto" | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "TaskCatalogs" | |
| ], | |
| "summary": "Deletes Task Catalog.", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Write.\n\nRequired permissions: TaskCatalogs.Delete.", | |
| "operationId": "TaskCatalogs_DeleteById", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "Id of the catalog to be deleted", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Successfully deleted task catalog." | |
| }, | |
| "409": { | |
| "description": "Catalog have associated tasks." | |
| }, | |
| "400": { | |
| "description": "Bad Request" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/TaskCatalogs({key})/UiPath.Server.Configuration.OData.UpdateTaskCatalog": { | |
| "post": { | |
| "tags": [ | |
| "TaskCatalogs" | |
| ], | |
| "summary": "Updates Task Catalog.", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Write.\n\nRequired permissions: TaskCatalogs.Edit.", | |
| "operationId": "TaskCatalogs_UpdateTaskCatalogById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "Key of the object", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "TaskCatalog to be updated", | |
| "schema": { | |
| "$ref": "#/definitions/TaskCatalogRequest" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Updated" | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/TaskCatalogs/UiPath.Server.Configuration.OData.CreateTaskCatalog": { | |
| "post": { | |
| "tags": [ | |
| "TaskCatalogs" | |
| ], | |
| "summary": "Creates a new Task Catalog.", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Write.\n\nRequired permissions: TaskCatalogs.Create.", | |
| "operationId": "TaskCatalogs_CreateTaskCatalog", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "The task catalog to be created.", | |
| "schema": { | |
| "$ref": "#/definitions/TaskCatalogRequest" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Created response.", | |
| "schema": { | |
| "$ref": "#/definitions/TaskCatalogDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/TaskCatalogs/UiPath.Server.Configuration.OData.GetFoldersForTaskCatalog(id={id})": { | |
| "get": { | |
| "tags": [ | |
| "TaskCatalogs" | |
| ], | |
| "summary": "Get all accessible folders where the task catalog is shared, and the total count of folders where it is shared (including unaccessible folders).", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Read.\n\nRequires authentication.", | |
| "operationId": "TaskCatalogs_GetFoldersForTaskCatalogById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/AccessibleFoldersDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/TaskCatalogs/UiPath.Server.Configuration.OData.GetTaskCatalogExtendedDetails(taskCatalogId={taskCatalogId})": { | |
| "get": { | |
| "tags": [ | |
| "TaskCatalogs" | |
| ], | |
| "summary": "Validates task catalog deletion request.", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Read.\n\nRequires authentication.", | |
| "operationId": "TaskCatalogs_GetTaskCatalogExtendedDetailsByTaskcatalogid", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "taskCatalogId", | |
| "description": "Id of task catalog", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/TaskCatalogExtendedDetailsDto" | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/TaskCatalogs/UiPath.Server.Configuration.OData.GetTaskCatalogsFromFoldersWithPermissions": { | |
| "get": { | |
| "tags": [ | |
| "TaskCatalogs" | |
| ], | |
| "summary": "Gets Task Catalogs across folders having given permission with the given OData queries .", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Read.\n\nRequires authentication.", | |
| "operationId": "TaskCatalogs_GetTaskCatalogsFromFoldersWithPermissions", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "mandatoryPermissions", | |
| "description": "These represent the additional permissions over TaskCatalog.Read required in the folders the data is retrieved from; all permissions in this set must be met", | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "excludeFolderId", | |
| "description": "The task catalogs beloging to this folder will be excluded.", | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "distinctBySelect", | |
| "description": "Return distinct attributes from task catalog for select query. Select param must have exactly 1 value if this is enabled", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Ok.", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfTaskCatalogDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/TaskCatalogs/UiPath.Server.Configuration.OData.ShareToFolders": { | |
| "post": { | |
| "tags": [ | |
| "TaskCatalogs" | |
| ], | |
| "summary": "Makes the task catalogs visible in the specified folders.", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Write.\n\nRequires authentication.", | |
| "operationId": "TaskCatalogs_ShareToFolders", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "Object containing the ids of the task catalogs and the ids of the folders where it should be shared.", | |
| "schema": { | |
| "$ref": "#/definitions/TaskCatalogFoldersShareDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| }, | |
| "404": { | |
| "description": "One of the specified entities does not exist." | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/TaskDefinitions": { | |
| "get": { | |
| "tags": [ | |
| "TaskDefinitions" | |
| ], | |
| "summary": "Gets Task Definition objects with the given OData queries.", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Read.\n\nRequired permissions: ActionDesign.View.", | |
| "operationId": "TaskDefinitions_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfTaskDefinitionDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/TaskDefinitions({key})": { | |
| "get": { | |
| "tags": [ | |
| "TaskDefinitions" | |
| ], | |
| "summary": "Gets a Task Definition item by Id.", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Read.\n\nRequired permissions: ActionDesign.View.", | |
| "operationId": "TaskDefinitions_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "id of the object", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/TaskDefinitionDto" | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "TaskDefinitions" | |
| ], | |
| "summary": "Deletes Task Defintion/Version.", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Write.\n\nRequired permissions: ActionDesign.Delete.", | |
| "operationId": "TaskDefinitions_DeleteById", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "Id of the task definition to be deleted", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "taskDefinitionVersion", | |
| "description": "Version of task definition to be deleted", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "Deletion Successful." | |
| }, | |
| "409": { | |
| "description": "Task Defintion has associated Apps/Actions" | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/TaskDefinitions({key})/UiPath.Server.Configuration.OData.UpdateTaskDefinition": { | |
| "post": { | |
| "tags": [ | |
| "TaskDefinitions" | |
| ], | |
| "summary": "Updates Task Definition.", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Write.\n\nRequired permissions: ActionDesign.Edit.", | |
| "operationId": "TaskDefinitions_UpdateTaskDefinitionById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "Key of the object", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "TaskDefinition to be updated", | |
| "schema": { | |
| "$ref": "#/definitions/TaskDefinitionRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Updated" | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/TaskDefinitions/UiPath.Server.Configuration.OData.CreateTaskDefinition": { | |
| "post": { | |
| "tags": [ | |
| "TaskDefinitions" | |
| ], | |
| "summary": "Creates a new Task Definition.", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Write.\n\nRequired permissions: ActionDesign.Create.", | |
| "operationId": "TaskDefinitions_CreateTaskDefinition", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "The Task Definition to be created.", | |
| "schema": { | |
| "$ref": "#/definitions/TaskDefinitionRequest" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Created response.", | |
| "schema": { | |
| "$ref": "#/definitions/TaskDefinitionDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/TaskDefinitions/UiPath.Server.Configuration.OData.GetTaskDefinitionVersions(id={id})": { | |
| "get": { | |
| "tags": [ | |
| "TaskDefinitions" | |
| ], | |
| "summary": "Get all versions of Task Definition.", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Read.\n\nRequired permissions: ActionDesign.View.", | |
| "operationId": "TaskDefinitions_GetTaskDefinitionVersionsById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "description": "Id of the Task Definition", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/TaskDefintionVersionDto" | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/TaskNotes/UiPath.Server.Configuration.OData.CreateTaskNote": { | |
| "post": { | |
| "tags": [ | |
| "TaskNotes" | |
| ], | |
| "summary": "Adds a task note.", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Write.\n\nRequired permissions: Tasks.Edit.", | |
| "operationId": "TaskNotes_CreateTaskNote", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "The note to be created.", | |
| "schema": { | |
| "$ref": "#/definitions/TaskNoteCreateRequest" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Created", | |
| "schema": { | |
| "$ref": "#/definitions/TaskNoteDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/TaskNotes/UiPath.Server.Configuration.OData.GetByTaskId(taskId={taskId})": { | |
| "get": { | |
| "tags": [ | |
| "TaskNotes" | |
| ], | |
| "summary": "Gets Task Notes for a Task", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Read.\n\nRequired permissions: Tasks.View.", | |
| "operationId": "TaskNotes_GetByTaskId", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "taskId", | |
| "description": "Id of the task", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfTaskNoteDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/TaskRetention": { | |
| "get": { | |
| "tags": [ | |
| "TaskRetention" | |
| ], | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Read.\n\nRequired permissions: TaskCatalogs.View.", | |
| "operationId": "TaskRetention_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfTaskRetentionSettingDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/TaskRetention({key})": { | |
| "get": { | |
| "tags": [ | |
| "TaskRetention" | |
| ], | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Read.\n\nRequired permissions: TaskCatalogs.View.", | |
| "operationId": "TaskRetention_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/TaskRetentionSettingDto" | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "TaskRetention" | |
| ], | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Write.\n\nRequired permissions: TaskCatalogs.Edit.", | |
| "operationId": "TaskRetention_PutById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "schema": { | |
| "$ref": "#/definitions/TaskRetentionSettingDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| }, | |
| "400": { | |
| "description": "Bad Request" | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "TaskRetention" | |
| ], | |
| "description": "OAuth required scopes: OR.Execution or OR.Execution.Write.\n\nRequired permissions: TaskCatalogs.Delete.", | |
| "operationId": "TaskRetention_DeleteById", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Tasks": { | |
| "get": { | |
| "tags": [ | |
| "Tasks" | |
| ], | |
| "summary": "Gets Task objects from classic folders with the given OData queries.", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Read.\n\nRequires authentication.", | |
| "operationId": "Tasks_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfTaskDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Tasks({key})": { | |
| "get": { | |
| "tags": [ | |
| "Tasks" | |
| ], | |
| "summary": "Gets a Task with the given primary key.", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Read.\n\nRequires authentication.", | |
| "operationId": "Tasks_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "The primary key of the Task to be retrieved.", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Ok result of Task object.", | |
| "schema": { | |
| "$ref": "#/definitions/TaskDto" | |
| } | |
| }, | |
| "404": { | |
| "description": "Not found result." | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Tasks/UiPath.Server.Configuration.OData.AssignTasks": { | |
| "post": { | |
| "tags": [ | |
| "Tasks" | |
| ], | |
| "summary": "Assigns the tasks to given users.", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Write.\n\nRequires authentication.", | |
| "operationId": "Tasks_AssignTasks", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "The json containing task and user Ids for assignment.", | |
| "schema": { | |
| "$ref": "#/definitions/TasksAssignRequest" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Update successful.", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfTaskOperationErrorResponse" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Tasks/UiPath.Server.Configuration.OData.DeleteTasks": { | |
| "post": { | |
| "tags": [ | |
| "Tasks" | |
| ], | |
| "summary": "Deletes the tasks.", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Write.\n\nRequires authentication.", | |
| "operationId": "Tasks_DeleteTasks", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "The json containing list of task ids for deletion.", | |
| "schema": { | |
| "$ref": "#/definitions/TasksDeleteRequest" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfTaskOperationErrorResponse" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Tasks/UiPath.Server.Configuration.OData.EditTaskMetadata": { | |
| "post": { | |
| "tags": [ | |
| "Tasks" | |
| ], | |
| "summary": "Edits the metadata of a task", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Write.\n\nRequires authentication.", | |
| "operationId": "Tasks_EditTaskMetadata", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/EditTaskMetadataRequest" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Ok, task updated successfully." | |
| }, | |
| "404": { | |
| "description": "Not found result." | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Tasks/UiPath.Server.Configuration.OData.GetByKey(identifier={identifier})": { | |
| "get": { | |
| "tags": [ | |
| "Tasks" | |
| ], | |
| "summary": "Gets a Task with the given guid.", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Read.\n\nRequires authentication.", | |
| "operationId": "Tasks_GetByKeyByIdentifier", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "identifier", | |
| "description": "The guid of the Task to be retrieved.", | |
| "required": true, | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Ok result of Task object.", | |
| "schema": { | |
| "$ref": "#/definitions/TaskDto" | |
| } | |
| }, | |
| "404": { | |
| "description": "Not found result." | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Tasks/UiPath.Server.Configuration.OData.GetTaskPermissions": { | |
| "get": { | |
| "tags": [ | |
| "Tasks" | |
| ], | |
| "summary": "Gets all the tasks related permissions for the logged in user on the folder in session", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Read.\n\nRequires authentication.", | |
| "operationId": "Tasks_GetTaskPermissions", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Ok.", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfPermissionDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Tasks/UiPath.Server.Configuration.OData.GetTasksAcrossFolders": { | |
| "get": { | |
| "tags": [ | |
| "Tasks" | |
| ], | |
| "summary": "Gets Task objects across folders (including Modern folders) with the given OData queries.", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Read.\n\nRequires authentication.", | |
| "operationId": "Tasks_GetTasksAcrossFolders", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "event", | |
| "description": "Operation performed on the task", | |
| "type": "string", | |
| "enum": [ | |
| "ForwardedEver" | |
| ], | |
| "x-ms-enum": { | |
| "name": "TaskEvent", | |
| "modelAsString": false | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Ok.", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfTaskDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Tasks/UiPath.Server.Configuration.OData.GetTasksAcrossFoldersForAdmin": { | |
| "get": { | |
| "tags": [ | |
| "Tasks" | |
| ], | |
| "summary": "Gets Task objects across folders (including Modern folders) where the current user has task admin permissions, with the given OData query options", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Read.\n\nRequires authentication.", | |
| "operationId": "Tasks_GetTasksAcrossFoldersForAdmin", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "event", | |
| "description": "Operation performed on the task", | |
| "type": "string", | |
| "enum": [ | |
| "ForwardedEver" | |
| ], | |
| "x-ms-enum": { | |
| "name": "TaskEvent", | |
| "modelAsString": false | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Ok.", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfTaskDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Tasks/UiPath.Server.Configuration.OData.GetTaskUsers(organizationUnitId={organizationUnitId})": { | |
| "get": { | |
| "tags": [ | |
| "Tasks" | |
| ], | |
| "summary": "Gets users in given Organization Unit, who have Tasks.View and Tasks.Edit permissions", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Read.\n\nRequired permissions: Tasks.View and Tasks.Edit.", | |
| "operationId": "Tasks_GetTaskUsersByOrganizationunitid", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "organizationUnitId", | |
| "description": "organizationUnitId of the task", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfUserLoginInfoDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Tasks/UiPath.Server.Configuration.OData.ReassignTasks": { | |
| "post": { | |
| "tags": [ | |
| "Tasks" | |
| ], | |
| "summary": "Reassigns the tasks to given users.", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Write.\n\nRequires authentication.", | |
| "operationId": "Tasks_ReassignTasks", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "The json containing task and user Ids for reassignment.", | |
| "schema": { | |
| "$ref": "#/definitions/TasksAssignRequest" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Update successful.", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfTaskOperationErrorResponse" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Tasks/UiPath.Server.Configuration.OData.UnassignTasks": { | |
| "post": { | |
| "tags": [ | |
| "Tasks" | |
| ], | |
| "summary": "Unassigns the tasks from the users.", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Write.\n\nRequires authentication.", | |
| "operationId": "Tasks_UnassignTasks", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "The json containing list of task ids for un-assignments.", | |
| "schema": { | |
| "$ref": "#/definitions/TasksDeleteRequest" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Update successful.", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfTaskOperationErrorResponse" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Tenants": { | |
| "get": { | |
| "tags": [ | |
| "Tenants" | |
| ], | |
| "summary": "Gets tenants.", | |
| "description": "OAuth required scopes: OR.Administration or OR.Administration.Read.\n\nHost only. Requires authentication.", | |
| "operationId": "Tenants_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "skipLastLoginTime", | |
| "description": "Skips computation of last login time for an improved performance", | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfTenantDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Tenants({key})": { | |
| "get": { | |
| "tags": [ | |
| "Tenants" | |
| ], | |
| "summary": "Gets a single tenant based on its id.", | |
| "description": "OAuth required scopes: OR.Administration or OR.Administration.Read.\n\nHost only. Requires authentication.", | |
| "operationId": "Tenants_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/TenantDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/TestCaseDefinitions": { | |
| "get": { | |
| "tags": [ | |
| "TestCaseDefinitions" | |
| ], | |
| "summary": "Returns a list of Test Case Definitions", | |
| "description": "OAuth required scopes: OR.TestSets or OR.TestSets.Read.\n\nRequired permissions: TestSets.View.\n\nResponses:\r\n200 Returns a list of Test Case Definitions filtered with queryOptions\r\n403 If the caller doesn't have permissions to view Test Case Definitions", | |
| "operationId": "TestCaseDefinitions_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "distinctByUniqueIdAndPackageIdentifier", | |
| "description": "To get one entry per UniqueId and PackageIdentifier combination", | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Returns a list of Test Case Definitions filtered with queryOptions", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfTestCaseDefinitionDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/TestCaseExecutions": { | |
| "get": { | |
| "tags": [ | |
| "TestCaseExecutions" | |
| ], | |
| "summary": "Returns a list of Test Case Executions", | |
| "description": "OAuth required scopes: OR.TestSetExecutions or OR.TestSetExecutions.Read.\n\nRequired permissions: TestSetExecutions.View.\n\nResponses:\r\n200 Return a specific Test Case Execution identified by key\r\n403 If the caller doesn't have permissions to view Test Set Executions", | |
| "operationId": "TestCaseExecutions_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Returns a list of Test Case Executions filtered with queryOptions", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfTestCaseExecutionDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/TestCaseExecutions({key})": { | |
| "get": { | |
| "tags": [ | |
| "TestCaseExecutions" | |
| ], | |
| "summary": "Return a specific Test Case Execution identified by key", | |
| "description": "OAuth required scopes: OR.TestSetExecutions or OR.TestSetExecutions.Read.\n\nRequired permissions: TestSetExecutions.View.\n\nResponses:\r\n200 Return a specific Test Case Execution identified by key\r\n403 If the caller doesn't have permissions to view Test Set Executions\r\n404 If the test case execution is not found", | |
| "operationId": "TestCaseExecutions_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Return a specific Test Case Execution identified by key", | |
| "schema": { | |
| "$ref": "#/definitions/TestCaseExecutionDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/TestDataQueueItems": { | |
| "get": { | |
| "tags": [ | |
| "TestDataQueueItems" | |
| ], | |
| "summary": "Return a list of test data queue items", | |
| "description": "OAuth required scopes: OR.TestDataQueues or OR.TestDataQueues.Read.\n\nRequired permissions: TestDataQueueItems.View.\n\nResponses:\r\n200 Returns a list of test data queue items filtered with queryOptions\r\n403 If the caller doesn't have permissions to view test data queue items", | |
| "operationId": "TestDataQueueItems_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Returns a list of test data queue items filtered with queryOptions", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfTestDataQueueItemODataDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/TestDataQueueItems({key})": { | |
| "get": { | |
| "tags": [ | |
| "TestDataQueueItems" | |
| ], | |
| "summary": "Return a specific test data queue item identified by key", | |
| "description": "OAuth required scopes: OR.TestDataQueues or OR.TestDataQueues.Read.\n\nRequired permissions: TestDataQueueItems.View.\n\nResponses:\r\n200 Returns a specific test data queue item identified by key\r\n403 If the caller doesn't have permissions to view test data queue items\r\n404 If the test data queue item is not found", | |
| "operationId": "TestDataQueueItems_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Returns a specific test data queue item identified by key", | |
| "schema": { | |
| "$ref": "#/definitions/TestDataQueueItemODataDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/TestDataQueues": { | |
| "get": { | |
| "tags": [ | |
| "TestDataQueues" | |
| ], | |
| "summary": "Return a list of test data queues", | |
| "description": "OAuth required scopes: OR.TestDataQueues or OR.TestDataQueues.Read.\n\nRequired permissions: TestDataQueues.View.\n\nResponses:\r\n200 Returns a list of test data queues filtered with queryOptions\r\n403 If the caller doesn't have permissions to view test data queues", | |
| "operationId": "TestDataQueues_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Returns a list of test data queues filtered with queryOptions", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfTestDataQueueDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "TestDataQueues" | |
| ], | |
| "summary": "Create a new test data queue", | |
| "description": "OAuth required scopes: OR.TestDataQueues or OR.TestDataQueues.Write.\n\nRequired permissions: TestDataQueues.Create.\n\nResponses:\r\n201 Returns the newly created test data queue\r\n403 If the caller doesn't have permissions to create test data queues\r\n409 If a queue with the same name already exists", | |
| "operationId": "TestDataQueues_Post", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/TestDataQueueDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Returns the newly created test data queue", | |
| "schema": { | |
| "$ref": "#/definitions/TestDataQueueDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/TestDataQueues({key})": { | |
| "get": { | |
| "tags": [ | |
| "TestDataQueues" | |
| ], | |
| "summary": "Return a specific test data queue identified by key", | |
| "description": "OAuth required scopes: OR.TestDataQueues or OR.TestDataQueues.Read.\n\nRequired permissions: TestDataQueues.View.\n\nResponses:\r\n200 Returns a specific test data queue identified by key\r\n403 If the caller doesn't have permissions to view test data queues\r\n404 If the test data queue is not found", | |
| "operationId": "TestDataQueues_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Returns a specific test data queue identified by key", | |
| "schema": { | |
| "$ref": "#/definitions/TestDataQueueDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "TestDataQueues" | |
| ], | |
| "summary": "Update an existing test data queue", | |
| "description": "OAuth required scopes: OR.TestDataQueues or OR.TestDataQueues.Write.\n\nRequired permissions: TestDataQueues.Edit.\n\nResponses:\r\n200 Returns the updated test data queue\r\n403 If the caller doesn't have permissions to update test data queues\r\n409 If trying to change the queue name", | |
| "operationId": "TestDataQueues_PutById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "Id of the test data queue to be updated", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "Update information", | |
| "schema": { | |
| "$ref": "#/definitions/TestDataQueueDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Returns the updated test data queue", | |
| "schema": { | |
| "$ref": "#/definitions/TestDataQueueDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "TestDataQueues" | |
| ], | |
| "summary": "Delete an existing test data queue", | |
| "description": "OAuth required scopes: OR.TestDataQueues or OR.TestDataQueues.Write.\n\nRequired permissions: TestDataQueues.Delete.\n\nResponses:\r\n204 The test data queue was deleted\r\n403 If the caller doesn't have permissions to delete test data queues", | |
| "operationId": "TestDataQueues_DeleteById", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "Id of the test data queue to be deleted", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/TestSetExecutions": { | |
| "get": { | |
| "tags": [ | |
| "TestSetExecutions" | |
| ], | |
| "summary": "Returns a list of Test Set Executions cross-folder when no current folder is sent by header.\r\nIt will return Test Set Executions from folder where current user has TestSetExecutionsView.\r\nIf there is none, will return forbidden.", | |
| "description": "OAuth required scopes: OR.TestSetExecutions or OR.TestSetExecutions.Read.\n\nRequired permissions: TestSetExecutions.View.\n\nResponses:\r\n200 Returns a list of Test Set Executions filtered with queryOptions\r\n403 If the caller doesn't have permissions to view Test Set Executions", | |
| "operationId": "TestSetExecutions_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "mandatoryPermissions", | |
| "description": "If in a cross-folder scenario, these represent the additional permissions\r\n required in the folders the data is retrieved from; all permissions in this set must be met", | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "atLeastOnePermissions", | |
| "description": "If in a cross-folder scenario, these represent the additional permissions\r\n required in the folders the data is retrieved from; at least one permission in this set must be met", | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Returns a list of Test Set Executions filtered with queryOptions", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfTestSetExecutionDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/TestSetExecutions({key})": { | |
| "get": { | |
| "tags": [ | |
| "TestSetExecutions" | |
| ], | |
| "summary": "Return a specific Test Set Execution identified by key", | |
| "description": "OAuth required scopes: OR.TestSetExecutions or OR.TestSetExecutions.Read.\n\nRequired permissions: TestSetExecutions.View.\n\nResponses:\r\n200 Return a specific Test Set Execution identified by key\r\n403 If the caller doesn't have permissions to view Test Set Executions\r\n404 It the test set execution is not found", | |
| "operationId": "TestSetExecutions_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Return a specific Test Set Execution identified by key", | |
| "schema": { | |
| "$ref": "#/definitions/TestSetExecutionDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/TestSets": { | |
| "get": { | |
| "tags": [ | |
| "TestSets" | |
| ], | |
| "summary": "Returns a list of Test Sets cross-folder when no current folder is sent by header.\r\nIt will return Test Sets from folder where current user has TestSetsView.\r\nIf there is none, will return forbidden.", | |
| "description": "OAuth required scopes: OR.TestSets or OR.TestSets.Read.\n\nRequired permissions: TestSets.View.\n\nResponses:\r\n200 Returns a list of Test Sets filtered with queryOptions\r\n403 If the caller doesn't have permissions to view Test Sets", | |
| "operationId": "TestSets_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "mandatoryPermissions", | |
| "description": "", | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "atLeastOnePermissions", | |
| "description": "", | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| }, | |
| "collectionFormat": "multi" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Returns a list of Test Sets filtered with queryOptions", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfTestSetDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "TestSets" | |
| ], | |
| "summary": "Creates a new Test Set", | |
| "description": "OAuth required scopes: OR.TestSets or OR.TestSets.Write.\n\nRequired permissions: TestSets.Create.\n\nResponses:\r\n201 Returns the newly created Test Set\r\n403 If the caller doesn't have permissions to create Test Sets", | |
| "operationId": "TestSets_Post", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/TestSetDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Returns the newly created Test Set", | |
| "schema": { | |
| "$ref": "#/definitions/TestSetDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/TestSets({key})": { | |
| "get": { | |
| "tags": [ | |
| "TestSets" | |
| ], | |
| "summary": "Return a specific Test Set identified by key", | |
| "description": "OAuth required scopes: OR.TestSets or OR.TestSets.Read.\n\nRequired permissions: TestSets.View.\n\nResponses:\r\n200 Return a specific Test Set identified by key\r\n403 If the caller doesn't have permissions to view Test Sets\r\n404 If the Test Set is not found", | |
| "operationId": "TestSets_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Return a specific Test Set identified by key", | |
| "schema": { | |
| "$ref": "#/definitions/TestSetDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "TestSets" | |
| ], | |
| "summary": "Update an existing Test Set", | |
| "description": "OAuth required scopes: OR.TestSets or OR.TestSets.Write.\n\nRequired permissions: TestSets.Edit.\n\nResponses:\r\n200 Returns the updated Test Set\r\n403 If the caller doesn't have permissions to update Test Sets", | |
| "operationId": "TestSets_PutById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "ID of the Test Set to be updated", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "Update information", | |
| "schema": { | |
| "$ref": "#/definitions/TestSetDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/TestSetDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "TestSets" | |
| ], | |
| "summary": "Delete a test set", | |
| "description": "OAuth required scopes: OR.TestSets or OR.TestSets.Write.\n\nRequired permissions: TestSets.Delete.\n\nResponses:\r\n204 The Test Set was deleted\r\n403 If the caller doesn't have permissions to delete Test Sets", | |
| "operationId": "TestSets_DeleteById", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "ID of the Test Set to delete", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/TestSetSchedules": { | |
| "get": { | |
| "tags": [ | |
| "TestSetSchedules" | |
| ], | |
| "summary": "Returns a list of test set execution schedules", | |
| "description": "OAuth required scopes: OR.TestSetSchedules or OR.TestSetSchedules.Read.\n\nRequired permissions: TestSetSchedules.View.\n\nResponses:\r\n200 Returns a list of test set execution schedules filtered with queryOptions\r\n403 If the caller doesn't have permissions to view test set execution schedules", | |
| "operationId": "TestSetSchedules_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Returns a list of test set execution schedules filtered with queryOptions", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfTestSetScheduleDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "TestSetSchedules" | |
| ], | |
| "summary": "Creates a new test set execution schedule", | |
| "description": "OAuth required scopes: OR.TestSetSchedules or OR.TestSetSchedules.Write.\n\nRequired permissions: TestSetSchedules.Create.\n\nResponses:\r\n201 Returns the newly created test set execution schedule\r\n403 If the caller doesn't have permissions to create test set execution schedules", | |
| "operationId": "TestSetSchedules_Post", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/TestSetScheduleDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Returns the newly created test set execution schedule", | |
| "schema": { | |
| "$ref": "#/definitions/TestSetScheduleDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/TestSetSchedules({key})": { | |
| "get": { | |
| "tags": [ | |
| "TestSetSchedules" | |
| ], | |
| "summary": "Return a specific test set execution schedule identified by key", | |
| "description": "OAuth required scopes: OR.TestSetSchedules or OR.TestSetSchedules.Read.\n\nRequired permissions: TestSetSchedules.View.\n\nResponses:\r\n200 Return a specific test set execution schedule identified by key\r\n403 If the caller doesn't have permissions to view test set execution schedules\r\n404 It the test set execution schedule is not found", | |
| "operationId": "TestSetSchedules_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Return a specific test set execution schedule identified by key", | |
| "schema": { | |
| "$ref": "#/definitions/TestSetScheduleDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "TestSetSchedules" | |
| ], | |
| "summary": "Update an existing test set execution schedule", | |
| "description": "OAuth required scopes: OR.TestSetSchedules or OR.TestSetSchedules.Write.\n\nRequired permissions: TestSetSchedules.Edit.\n\nResponses:\r\n201 Returns the updated test set execution schedule\r\n403 If the caller doesn't have permissions to update test set execution schedules", | |
| "operationId": "TestSetSchedules_PutById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "ID of the test set execution schedule to be updated", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "Update information", | |
| "schema": { | |
| "$ref": "#/definitions/TestSetScheduleDto" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/TestSetScheduleDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "TestSetSchedules" | |
| ], | |
| "summary": "Delete an existing test set execution schedule", | |
| "description": "OAuth required scopes: OR.TestSetSchedules or OR.TestSetSchedules.Write.\n\nRequired permissions: TestSetSchedules.Delete.\n\nResponses:\r\n204 The test set execution schedule was deleted\r\n403 If the caller doesn't have permissions to delete test set execution schedules", | |
| "operationId": "TestSetSchedules_DeleteById", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "ID of the test set execution schedule to be deleted", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/TestSetSchedules/UiPath.Server.Configuration.OData.SetEnabled": { | |
| "post": { | |
| "tags": [ | |
| "TestSetSchedules" | |
| ], | |
| "summary": "Enables / disables a list of test set execution schedules.", | |
| "description": "OAuth required scopes: OR.TestSetSchedules or OR.TestSetSchedules.Write.\n\nRequired permissions: TestSetSchedules.Edit.", | |
| "operationId": "TestSetSchedules_SetEnabled", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "<para />enabled: if true the test set schedules will be enabled, if false they will be disabled.\r\n <para />scheduleIds: the ids of the test set schedules to be enabled or disabled.", | |
| "schema": { | |
| "$ref": "#/definitions/TestSetSchedulesEnabledRequest" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfBoolean" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Users": { | |
| "get": { | |
| "tags": [ | |
| "Users" | |
| ], | |
| "summary": "Gets users.", | |
| "description": "OAuth required scopes: OR.Users or OR.Users.Read.\n\nRequired permissions: Users.View.", | |
| "operationId": "Users_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfUserDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "Users" | |
| ], | |
| "summary": "Creates a new user.", | |
| "description": "OAuth required scopes: OR.Users or OR.Users.Write.\n\nRequired permissions: Users.Create.", | |
| "operationId": "Users_Post", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/UserDto" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Created", | |
| "schema": { | |
| "$ref": "#/definitions/UserDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Users({key})": { | |
| "get": { | |
| "tags": [ | |
| "Users" | |
| ], | |
| "summary": "Gets a user based on its id.", | |
| "description": "OAuth required scopes: OR.Users or OR.Users.Read.\n\nRequires authentication.", | |
| "operationId": "Users_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/UserDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "Users" | |
| ], | |
| "summary": "Edits a user.", | |
| "description": "OAuth required scopes: OR.Users or OR.Users.Write.\n\nRequired permissions: Users.Edit or Robots.Create or Robots.Edit or Robots.Delete.", | |
| "operationId": "Users_PutById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/UserDto" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "Users" | |
| ], | |
| "summary": "Partially updates a user.\r\nCannot update roles or organization units via this endpoint.", | |
| "description": "OAuth required scopes: OR.Users or OR.Users.Write.\n\nRequires authentication.", | |
| "operationId": "Users_PatchById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/UserDto" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Users" | |
| ], | |
| "summary": "Deletes a user.", | |
| "description": "OAuth required scopes: OR.Users or OR.Users.Write.\n\nRequired permissions: Users.Delete.", | |
| "operationId": "Users_DeleteById", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Users({key})/UiPath.Server.Configuration.OData.AssignRoles": { | |
| "post": { | |
| "tags": [ | |
| "Users" | |
| ], | |
| "description": "OAuth required scopes: OR.Users or OR.Users.Write.\n\nRequired permissions: Users.Edit or Users.Create.", | |
| "operationId": "Users_AssignRolesById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "schema": { | |
| "$ref": "#/definitions/UserAssignRolesRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Users({key})/UiPath.Server.Configuration.OData.ChangeUserCulture": { | |
| "post": { | |
| "tags": [ | |
| "Users" | |
| ], | |
| "summary": "Changes the culture for the specified user", | |
| "description": "OAuth required scopes: OR.Users or OR.Users.Write.\n\nRequired permissions: Users.Edit.", | |
| "operationId": "Users_ChangeUserCultureById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/UserChangeCultureRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Users({key})/UiPath.Server.Configuration.OData.ToggleRole": { | |
| "post": { | |
| "tags": [ | |
| "Users" | |
| ], | |
| "summary": "Associates/dissociates the given user with/from a role based on toggle parameter.", | |
| "description": "OAuth required scopes: OR.Users or OR.Users.Write.\n\nRequired permissions: Users.Edit.", | |
| "operationId": "Users_ToggleRoleById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "<para />Toggle - States whether to associate or to dissociate the role with/from the user.\r\n <para />Role - The name of the role to be associated/dissociated.", | |
| "schema": { | |
| "$ref": "#/definitions/UsersToggleRoleRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Users/UiPath.Server.Configuration.OData.ChangeCulture": { | |
| "post": { | |
| "tags": [ | |
| "Users" | |
| ], | |
| "summary": "Changes the culture for the current user", | |
| "description": "OAuth required scopes: OR.Users or OR.Users.Write.\n\nRequires authentication.", | |
| "operationId": "Users_ChangeCulture", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/UserChangeCultureRequest" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Users/UiPath.Server.Configuration.OData.GetByKey(identifier={identifier})": { | |
| "get": { | |
| "tags": [ | |
| "Users" | |
| ], | |
| "summary": "Gets a user based on its id.", | |
| "description": "OAuth required scopes: OR.Users or OR.Users.Read.\n\nRequires authentication.", | |
| "operationId": "Users_GetByKeyByIdentifier", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "identifier", | |
| "description": "", | |
| "required": true, | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/UserDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Users/UiPath.Server.Configuration.OData.GetCurrentPermissions": { | |
| "get": { | |
| "tags": [ | |
| "Users" | |
| ], | |
| "summary": "Returns a user permission collection containing data about the current user and all the permissions it has.", | |
| "description": "OAuth required scopes: OR.Users or OR.Users.Read.\n\nRequires authentication.", | |
| "operationId": "Users_GetCurrentPermissions", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/UserPermissionsCollection" | |
| } | |
| }, | |
| "401": { | |
| "description": "Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Users/UiPath.Server.Configuration.OData.GetCurrentUser": { | |
| "get": { | |
| "tags": [ | |
| "Users" | |
| ], | |
| "summary": "Returns details about the user currently logged into Orchestrator.", | |
| "description": "OAuth required scopes: OR.Users or OR.Users.Read.", | |
| "operationId": "Users_GetCurrentUser", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/UserDto" | |
| } | |
| }, | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Users/UiPath.Server.Configuration.OData.Validate(userIds=[{userIds}])": { | |
| "get": { | |
| "tags": [ | |
| "Users" | |
| ], | |
| "summary": "Validates if the robots for the given users are busy", | |
| "description": "OAuth required scopes: OR.Users or OR.Users.Read.\n\nRequired permissions: Users.View.", | |
| "operationId": "Users_ValidateByUserids", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "userIds", | |
| "description": "The Id of the users to check", | |
| "required": true, | |
| "type": "array", | |
| "items": { | |
| "format": "int64", | |
| "type": "integer" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIDictionaryOfInt64Boolean" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Webhooks": { | |
| "get": { | |
| "tags": [ | |
| "Webhooks" | |
| ], | |
| "summary": "List webhooks", | |
| "description": "OAuth required scopes: OR.Webhooks or OR.Webhooks.Read.\n\nRequired permissions: Webhooks.View.", | |
| "operationId": "Webhooks_Get", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$top", | |
| "description": "Limits the number of items returned from a collection. The maximum value is 1000.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$skip", | |
| "description": "Excludes the specified number of items of the queried collection from the result.", | |
| "type": "integer", | |
| "format": "int32" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfWebhookDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "post": { | |
| "tags": [ | |
| "Webhooks" | |
| ], | |
| "summary": "Create a new webhook subscription", | |
| "description": "OAuth required scopes: OR.Webhooks or OR.Webhooks.Write.\n\nRequired permissions: Webhooks.Create.", | |
| "operationId": "Webhooks_Post", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WebhookDto" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Created", | |
| "schema": { | |
| "$ref": "#/definitions/WebhookDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Webhooks({key})": { | |
| "get": { | |
| "tags": [ | |
| "Webhooks" | |
| ], | |
| "summary": "Gets a single webhook", | |
| "description": "OAuth required scopes: OR.Webhooks or OR.Webhooks.Read.\n\nRequired permissions: Webhooks.View.", | |
| "operationId": "Webhooks_GetById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/WebhookDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "put": { | |
| "tags": [ | |
| "Webhooks" | |
| ], | |
| "summary": "Update an existing webhook subscription", | |
| "description": "OAuth required scopes: OR.Webhooks or OR.Webhooks.Write.\n\nRequired permissions: Webhooks.Edit.", | |
| "operationId": "Webhooks_PutById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WebhookDto" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/WebhookDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "patch": { | |
| "tags": [ | |
| "Webhooks" | |
| ], | |
| "summary": "Patches a webhook", | |
| "description": "OAuth required scopes: OR.Webhooks or OR.Webhooks.Write.\n\nRequired permissions: Webhooks.Edit.", | |
| "operationId": "Webhooks_PatchById", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "", | |
| "schema": { | |
| "$ref": "#/definitions/WebhookDto" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/WebhookDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Webhooks" | |
| ], | |
| "summary": "Delete a webhook subscription", | |
| "description": "OAuth required scopes: OR.Webhooks or OR.Webhooks.Write.\n\nRequired permissions: Webhooks.Delete.", | |
| "operationId": "Webhooks_DeleteById", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Webhooks({key})/UiPath.Server.Configuration.OData.Ping": { | |
| "post": { | |
| "tags": [ | |
| "Webhooks" | |
| ], | |
| "summary": "Sends a Ping request to webhook endpoint.\r\nUsed for testing connectivity and availability of target URL", | |
| "description": "OAuth required scopes: OR.Webhooks or OR.Webhooks.Write.\n\nRequired permissions: Webhooks.View.", | |
| "operationId": "Webhooks_PingById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "key", | |
| "description": "", | |
| "required": true, | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "202": { | |
| "description": "Accepted", | |
| "schema": { | |
| "$ref": "#/definitions/PingEventDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Webhooks/UiPath.Server.Configuration.OData.GetEventTypes": { | |
| "get": { | |
| "tags": [ | |
| "Webhooks" | |
| ], | |
| "summary": "Gets the list of event types a webhook can subscribe to", | |
| "description": "OAuth required scopes: OR.Webhooks or OR.Webhooks.Read.\n\nRequired permissions: Webhooks.View.", | |
| "operationId": "Webhooks_GetEventTypes", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$filter", | |
| "description": "Restricts the set of items returned. The maximum number of expressions is 100.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$orderby", | |
| "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$count", | |
| "description": "Indicates whether the total count of items within a collection are returned in the result.", | |
| "type": "boolean" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/ODataValueOfIEnumerableOfWebhookEventTypeDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/odata/Webhooks/UiPath.Server.Configuration.OData.TriggerCustom": { | |
| "post": { | |
| "tags": [ | |
| "Webhooks" | |
| ], | |
| "summary": "Triggers an event of type \"custom\"", | |
| "description": "OAuth required scopes: OR.Webhooks or OR.Webhooks.Write.\n\nRequired permissions: Webhooks.View.", | |
| "operationId": "Webhooks_TriggerCustom", | |
| "consumes": [ | |
| "application/json;odata.metadata=minimal;odata.streaming=true", | |
| "application/json;odata.metadata=minimal;odata.streaming=false", | |
| "application/json;odata.metadata=minimal", | |
| "application/json;odata.metadata=full;odata.streaming=true", | |
| "application/json;odata.metadata=full;odata.streaming=false", | |
| "application/json;odata.metadata=full", | |
| "application/json;odata.metadata=none;odata.streaming=true", | |
| "application/json;odata.metadata=none;odata.streaming=false", | |
| "application/json;odata.metadata=none", | |
| "application/json;odata.streaming=true", | |
| "application/json;odata.streaming=false", | |
| "application/json", | |
| "application/json-patch+json", | |
| "application/*+json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "Any custom event data payload", | |
| "schema": { | |
| "type": "object", | |
| "additionalProperties": {} | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$expand", | |
| "description": "Indicates the related entities to be represented inline. The maximum depth is 2.", | |
| "type": "string" | |
| }, | |
| { | |
| "in": "query", | |
| "name": "$select", | |
| "description": "Limits the properties returned in the result.", | |
| "type": "string" | |
| } | |
| ], | |
| "responses": { | |
| "202": { | |
| "description": "Accepted", | |
| "schema": { | |
| "$ref": "#/definitions/CustomEventDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/tasks/AppTasks/CompleteAppTask": { | |
| "post": { | |
| "tags": [ | |
| "AppTasks" | |
| ], | |
| "summary": "Complete the task by saving app task data and action taken", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Write.\n\nRequired permissions: Tasks.Edit.", | |
| "operationId": "AppTasks_CompleteAppTask", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "TaskCompletionRequest", | |
| "schema": { | |
| "$ref": "#/definitions/TaskCompletionRequest" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| }, | |
| "400": { | |
| "description": "Bad Request" | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/tasks/AppTasks/CreateAppTask": { | |
| "post": { | |
| "tags": [ | |
| "AppTasks" | |
| ], | |
| "summary": "Creates a new App Task.", | |
| "description": "OAuth required scopes: ((JamJamApi or JamJamApi.Write) and (RCS.FolderAuthorization or RCS.FolderAuthorization.Write)) and (OR.Tasks or OR.Tasks.Write).\n\nRequired permissions: Tasks.Create.", | |
| "operationId": "AppTasks_CreateAppTask", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "The app task to be created.", | |
| "schema": { | |
| "$ref": "#/definitions/AppTasksCreateRequest" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Created", | |
| "schema": { | |
| "$ref": "#/definitions/AppTasksDataDto" | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/tasks/AppTasks/GetAppTaskById": { | |
| "get": { | |
| "tags": [ | |
| "AppTasks" | |
| ], | |
| "summary": "Returns dto to render app task", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Read.\n\nRequired permissions: Tasks.View.", | |
| "operationId": "AppTasks_GetAppTaskById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "taskId", | |
| "description": "Task id", | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/AppTasksDataDto" | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/tasks/AppTasks/GetAppTaskByKey": { | |
| "get": { | |
| "tags": [ | |
| "AppTasks" | |
| ], | |
| "summary": "Returns dto to render app task", | |
| "description": "OAuth required scopes: ((JamJamApi or JamJamApi.Read) and (RCS.FolderAuthorization or RCS.FolderAuthorization.Read)) and (OR.Tasks or OR.Tasks.Read).\n\nRequired permissions: Tasks.View.", | |
| "operationId": "AppTasks_GetAppTaskByKey", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "taskKey", | |
| "description": "Task key", | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/AppTasksDataDto" | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/tasks/AppTasks/SaveAndReassignAppTasks": { | |
| "post": { | |
| "tags": [ | |
| "AppTasks" | |
| ], | |
| "summary": "Save changes done by the current user and Reassign Task to another user", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Write.\n\nRequired permissions: Tasks.Edit.", | |
| "operationId": "AppTasks_SaveAndReassignAppTasks", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "TaskSaveAndReassignmentRequest", | |
| "schema": { | |
| "$ref": "#/definitions/TaskSaveAndReassignmentRequest" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| }, | |
| "400": { | |
| "description": "Bad Request" | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/tasks/AppTasks/SaveAppTasksData": { | |
| "put": { | |
| "tags": [ | |
| "AppTasks" | |
| ], | |
| "summary": "Save task data", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Write.\n\nRequired permissions: Tasks.Edit.", | |
| "operationId": "AppTasks_SaveAppTasksData", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "TaskDataSaveRequest", | |
| "schema": { | |
| "$ref": "#/definitions/TaskDataSaveRequest" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| }, | |
| "400": { | |
| "description": "Bad Request" | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/tasks/GenericTasks/CompleteTask": { | |
| "post": { | |
| "tags": [ | |
| "GenericTasks" | |
| ], | |
| "summary": "Complete the task by saving task data and action taken", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Write.\n\nRequired permissions: Tasks.Edit.", | |
| "operationId": "GenericTasks_CompleteTask", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "TaskCompletionRequest", | |
| "schema": { | |
| "$ref": "#/definitions/TaskCompletionRequest" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| }, | |
| "400": { | |
| "description": "Bad Request" | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/tasks/GenericTasks/CreateTask": { | |
| "post": { | |
| "tags": [ | |
| "GenericTasks" | |
| ], | |
| "summary": "Creates a new Generic Task.", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Write.\n\nRequired permissions: Tasks.Create.", | |
| "operationId": "GenericTasks_CreateTask", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "The task to be created.", | |
| "schema": { | |
| "$ref": "#/definitions/TaskCreateRequest" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "201": { | |
| "description": "Created", | |
| "schema": { | |
| "$ref": "#/definitions/TaskDataDto" | |
| } | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/tasks/GenericTasks/GetTaskDataById": { | |
| "get": { | |
| "tags": [ | |
| "GenericTasks" | |
| ], | |
| "summary": "Returns task data dto", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Read.\n\nRequired permissions: Tasks.View.", | |
| "operationId": "GenericTasks_GetTaskDataById", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "taskId", | |
| "description": "Task id", | |
| "type": "integer", | |
| "format": "int64" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/TaskDataDto" | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/tasks/GenericTasks/GetTaskDataByKey": { | |
| "get": { | |
| "tags": [ | |
| "GenericTasks" | |
| ], | |
| "summary": "Returns task data dto", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Read.\n\nRequired permissions: Tasks.View.", | |
| "operationId": "GenericTasks_GetTaskDataByKey", | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "taskKey", | |
| "description": "Task Key", | |
| "type": "string", | |
| "format": "uuid" | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "Success", | |
| "schema": { | |
| "$ref": "#/definitions/TaskDataDto" | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/tasks/GenericTasks/SaveAndReassignTask": { | |
| "post": { | |
| "tags": [ | |
| "GenericTasks" | |
| ], | |
| "summary": "Save changes done by the current user and Reassign Task to another user", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Write.\n\nRequired permissions: Tasks.Edit.", | |
| "operationId": "GenericTasks_SaveAndReassignTask", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "TaskSaveAndReassignmentRequest", | |
| "schema": { | |
| "$ref": "#/definitions/TaskSaveAndReassignmentRequest" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| }, | |
| "400": { | |
| "description": "Bad Request" | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/tasks/GenericTasks/SaveTaskData": { | |
| "put": { | |
| "tags": [ | |
| "GenericTasks" | |
| ], | |
| "summary": "Save Task data", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Write.\n\nRequired permissions: Tasks.Edit.", | |
| "operationId": "GenericTasks_SaveTaskData", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "TaskDataSaveRequest", | |
| "schema": { | |
| "$ref": "#/definitions/TaskDataSaveRequest" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| }, | |
| "400": { | |
| "description": "Bad Request" | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| }, | |
| "/tasks/GenericTasks/SaveTaskTags": { | |
| "put": { | |
| "tags": [ | |
| "GenericTasks" | |
| ], | |
| "summary": "Save tags for a task", | |
| "description": "OAuth required scopes: OR.Tasks or OR.Tasks.Write.\n\nRequired permissions: Tasks.Edit.", | |
| "operationId": "GenericTasks_SaveTaskTags", | |
| "consumes": [ | |
| "application/json" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "body", | |
| "name": "body", | |
| "description": "TaskTagsSaveRequest", | |
| "schema": { | |
| "$ref": "#/definitions/TaskTagsSaveRequest" | |
| } | |
| }, | |
| { | |
| "in": "header", | |
| "name": "X-UIPATH-OrganizationUnitId", | |
| "description": "Folder/OrganizationUnit Id", | |
| "type": "integer", | |
| "format": "int64" | |
| } | |
| ], | |
| "responses": { | |
| "204": { | |
| "description": "No Content" | |
| }, | |
| "400": { | |
| "description": "Bad Request" | |
| }, | |
| "404": { | |
| "description": "Not Found" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "OAuth2": [] | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "definitions": { | |
| "AccessibleFoldersDto": { | |
| "type": "object", | |
| "properties": { | |
| "AccessibleFolders": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/SimpleFolderDto" | |
| } | |
| }, | |
| "TotalFoldersCount": { | |
| "format": "int32", | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "ActionableMessageAction": { | |
| "description": "Type definition for Actionable Message Command.", | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "description": "Unique Identifier of the field", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "description": "Name of the command", | |
| "type": "string" | |
| }, | |
| "title": { | |
| "description": "Title of the command", | |
| "type": "string" | |
| }, | |
| "type": { | |
| "description": "Type of the field (e.g. Input.Text)", | |
| "type": "string" | |
| }, | |
| "isPrimary": { | |
| "description": "Indicates if the action is primary or secondary", | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "ActionableMessageActionSet": { | |
| "description": "Set of Commands for Actionable Message", | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "description": "Unique Identifier of the field", | |
| "type": "string" | |
| }, | |
| "type": { | |
| "description": "Action Set Type", | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "actions": { | |
| "description": "Set of Actions", | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ActionableMessageAction" | |
| } | |
| } | |
| } | |
| }, | |
| "ActionableMessageField": { | |
| "description": "Type definition for Actionable Message Field.", | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "description": "Unique Identifier of the field", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "description": "Name of the field", | |
| "type": "string" | |
| }, | |
| "title": { | |
| "description": "Name of the field", | |
| "type": "string" | |
| }, | |
| "type": { | |
| "description": "Type of the field (e.g. Input.Text)", | |
| "type": "string" | |
| }, | |
| "placeHolderText": { | |
| "description": "Placeholder text for the field", | |
| "type": "string" | |
| }, | |
| "value": { | |
| "description": "Value of the field", | |
| "type": "string" | |
| }, | |
| "isHeader": { | |
| "description": "Is the field header", | |
| "type": "boolean" | |
| }, | |
| "isRequired": { | |
| "description": "Is the field Required", | |
| "type": "boolean" | |
| }, | |
| "sequence": { | |
| "format": "int32", | |
| "description": "Sequence of the field", | |
| "type": "integer" | |
| }, | |
| "horizontalAlignment": { | |
| "description": "Defines horizontal alignment of the field", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "ActionableMessageFieldSet": { | |
| "description": "Set of Fields for Actionable Message", | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "description": "Unique Identifier of the field", | |
| "type": "string" | |
| }, | |
| "type": { | |
| "description": "Action Set Type", | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "fields": { | |
| "description": "Set of fields", | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/ActionableMessageField" | |
| } | |
| } | |
| } | |
| }, | |
| "ActionableMessageMetaData": { | |
| "description": "Type definition for Actionable Message Schema.", | |
| "type": "object", | |
| "properties": { | |
| "fieldSet": { | |
| "$ref": "#/definitions/ActionableMessageFieldSet" | |
| }, | |
| "actionSet": { | |
| "$ref": "#/definitions/ActionableMessageActionSet" | |
| } | |
| } | |
| }, | |
| "ActivitySettingsDto": { | |
| "description": "Activity settings", | |
| "type": "object", | |
| "properties": { | |
| "ApiVersion": { | |
| "description": "Current Orchestrator api version", | |
| "type": "string" | |
| }, | |
| "SignalR": { | |
| "$ref": "#/definitions/SignalRActivitySettingsDto" | |
| } | |
| } | |
| }, | |
| "AddQueueItemRequest": { | |
| "required": [ | |
| "itemData" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "itemData": { | |
| "$ref": "#/definitions/QueueItemDataDto" | |
| } | |
| } | |
| }, | |
| "AgentSettings": { | |
| "type": "object", | |
| "properties": { | |
| "Memory": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "AlertDto": { | |
| "description": "Stores notification data used to inform the users about specific application events.", | |
| "required": [ | |
| "Severity" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "NotificationName": { | |
| "description": "The name of a specific type of notification, e.g. Robot.StatusChanged.NotResponding.", | |
| "type": "string" | |
| }, | |
| "Data": { | |
| "description": "Stores data about the context in which the event occurred, in JSON format.", | |
| "type": "string" | |
| }, | |
| "Component": { | |
| "description": "The component that raised the alert.", | |
| "enum": [ | |
| "Robots", | |
| "Transactions", | |
| "Schedules", | |
| "Jobs", | |
| "Process", | |
| "Tasks", | |
| "Queues", | |
| "Folders", | |
| "PersonalWorkspaces", | |
| "TestAutomation", | |
| "Insights", | |
| "CloudRobots", | |
| "ConnectedTriggers", | |
| "Serverless", | |
| "Export", | |
| "RateLimits", | |
| "AutopilotForRobots", | |
| "Webhooks" | |
| ], | |
| "type": "string", | |
| "x-ms-enum": { | |
| "name": "AlertDtoComponent", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "Robots", | |
| "Transactions", | |
| "Schedules", | |
| "Jobs", | |
| "Process", | |
| "Tasks", | |
| "Queues", | |
| "Folders", | |
| "PersonalWorkspaces", | |
| "TestAutomation", | |
| "Insights", | |
| "CloudRobots", | |
| "ConnectedTriggers", | |
| "Serverless", | |
| "Export", | |
| "RateLimits", | |
| "AutopilotForRobots", | |
| "Webhooks" | |
| ] | |
| }, | |
| "Severity": { | |
| "description": "The severity level of the alert.", | |
| "enum": [ | |
| "Info", | |
| "Success", | |
| "Warn", | |
| "Error", | |
| "Fatal" | |
| ], | |
| "type": "string", | |
| "x-ms-enum": { | |
| "name": "AlertDtoSeverity", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "Info", | |
| "Success", | |
| "Warn", | |
| "Error", | |
| "Fatal" | |
| ] | |
| }, | |
| "CreationTime": { | |
| "format": "date-time", | |
| "description": "The date and time when the alert was generated.", | |
| "type": "string" | |
| }, | |
| "State": { | |
| "description": "Defines if a specified notification has been read or not.\r\n<para />Members: Unread (0) - the specified notification has not been marked as read; Read (1) - the specified notification has been marked as read.", | |
| "enum": [ | |
| "Unread", | |
| "Read" | |
| ], | |
| "type": "string", | |
| "x-ms-enum": { | |
| "name": "AlertDtoState", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "Unread", | |
| "Read" | |
| ] | |
| }, | |
| "UserNotificationId": { | |
| "format": "uuid", | |
| "description": "The database unique identifier for the alert notification sent to the current user.", | |
| "type": "string" | |
| }, | |
| "DeepLinkRelativeUrl": { | |
| "description": "Relative deep link for front-end usage.\r\ne.g /alerts/deeplink/{alert_title}?{alert_param1}={alert_param1_value}&{alert_param2}={alert_param2_value}", | |
| "type": "string" | |
| }, | |
| "Id": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "AlertsMarkAsReadRequest": { | |
| "required": [ | |
| "ids" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "ids": { | |
| "type": "array", | |
| "items": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "AlertsSubscribedEventDto": { | |
| "required": [ | |
| "EventId", | |
| "Timestamp", | |
| "Type" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "Type": { | |
| "minLength": 1, | |
| "type": "string" | |
| }, | |
| "EventId": { | |
| "maxLength": 50, | |
| "minLength": 0, | |
| "type": "string" | |
| }, | |
| "EntityKey": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "Timestamp": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "IsUserGroup": { | |
| "type": "boolean" | |
| }, | |
| "NotificationNames": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "IsEmailDisabled": { | |
| "type": "boolean" | |
| }, | |
| "EventTime": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "EventSourceId": { | |
| "format": "int64", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "TenantId": { | |
| "format": "int32", | |
| "type": "integer" | |
| }, | |
| "OrganizationUnitId": { | |
| "format": "int64", | |
| "type": "integer" | |
| }, | |
| "OrganizationUnitKey": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "UserKey": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "UserId": { | |
| "format": "int64", | |
| "type": "integer" | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "x-webhook-event": "alert.subscribed" | |
| }, | |
| "AlertsUnsubscribedEventDto": { | |
| "required": [ | |
| "EventId", | |
| "Timestamp", | |
| "Type" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "Type": { | |
| "minLength": 1, | |
| "type": "string" | |
| }, | |
| "EventId": { | |
| "maxLength": 50, | |
| "minLength": 0, | |
| "type": "string" | |
| }, | |
| "EntityKey": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "Timestamp": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "IsUserGroup": { | |
| "type": "boolean" | |
| }, | |
| "NotificationNames": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| }, | |
| "IsEmailDisabled": { | |
| "type": "boolean" | |
| }, | |
| "EventTime": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "EventSourceId": { | |
| "format": "int64", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "TenantId": { | |
| "format": "int32", | |
| "type": "integer" | |
| }, | |
| "OrganizationUnitId": { | |
| "format": "int64", | |
| "type": "integer" | |
| }, | |
| "OrganizationUnitKey": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "UserKey": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "UserId": { | |
| "format": "int64", | |
| "type": "integer" | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "x-webhook-event": "alert.unsubscribed" | |
| }, | |
| "ApiTriggerCreatedEvent": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "enum": [ | |
| "Api", | |
| "Http" | |
| ], | |
| "type": "string", | |
| "readOnly": true, | |
| "x-ms-enum": { | |
| "name": "ApiTriggerCreatedEventType", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "Api", | |
| "Http" | |
| ] | |
| }, | |
| "organizationUnitFullyQualifiedName": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "externalReference": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "jobCount": { | |
| "format": "int32", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "jobPriority": { | |
| "format": "int32", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "requiresUserInteraction": { | |
| "type": "boolean" | |
| }, | |
| "alertPendingJobAfterSeconds": { | |
| "format": "int32", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "alertRunningJobAfterSeconds": { | |
| "format": "int32", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "stopJobAfterSeconds": { | |
| "format": "int32", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "killJobAfterSeconds": { | |
| "format": "int32", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "remoteControlAccess": { | |
| "enum": [ | |
| "None", | |
| "ReadOnly", | |
| "Full" | |
| ], | |
| "type": "string", | |
| "readOnly": true, | |
| "x-ms-enum": { | |
| "name": "ApiTriggerCreatedEventRemoteControlAccess", | |
| "modelAsString": false | |
| } | |
| }, | |
| "apiTriggerType": { | |
| "enum": [ | |
| "Manual", | |
| "IntegrationTrigger", | |
| "AutomationOpsPipelines" | |
| ], | |
| "type": "string", | |
| "readOnly": true, | |
| "x-ms-enum": { | |
| "name": "ApiTriggerCreatedEventApiTriggerType", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "Manual", | |
| "IntegrationTrigger", | |
| "AutomationOpsPipelines" | |
| ] | |
| }, | |
| "isConnected": { | |
| "type": "boolean", | |
| "readOnly": true | |
| }, | |
| "key": { | |
| "format": "uuid", | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "description": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "enabled": { | |
| "type": "boolean", | |
| "readOnly": true | |
| }, | |
| "releaseKey": { | |
| "format": "uuid", | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "runtimeType": { | |
| "enum": [ | |
| "NonProduction", | |
| "Attended", | |
| "Unattended", | |
| "Development", | |
| "Studio", | |
| "RpaDeveloper", | |
| "StudioX", | |
| "CitizenDeveloper", | |
| "Headless", | |
| "StudioPro", | |
| "RpaDeveloperPro", | |
| "TestAutomation", | |
| "AutomationCloud", | |
| "Serverless", | |
| "AutomationKit", | |
| "ServerlessTestAutomation", | |
| "AutomationCloudTestAutomation", | |
| "AttendedStudioWeb", | |
| "Hosting", | |
| "AssistantWeb", | |
| "ProcessOrchestration", | |
| "AgentService", | |
| "AppTest", | |
| "PerformanceTest", | |
| "BusinessRule", | |
| "CaseManagement" | |
| ], | |
| "type": "string", | |
| "readOnly": true, | |
| "x-ms-enum": { | |
| "name": "BaseTriggerEventRuntimeType", | |
| "modelAsString": false | |
| } | |
| }, | |
| "stopStrategy": { | |
| "enum": [ | |
| "SoftStop", | |
| "Kill" | |
| ], | |
| "type": "string", | |
| "readOnly": true, | |
| "x-ms-enum": { | |
| "name": "BaseTriggerEventStopStrategy", | |
| "modelAsString": false | |
| } | |
| }, | |
| "resumeOnSameContext": { | |
| "type": "boolean", | |
| "readOnly": true | |
| }, | |
| "consecutiveJobFailuresThreshold": { | |
| "format": "int32", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "jobFailuresGracePeriodInHours": { | |
| "format": "int32", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "runAsMe": { | |
| "type": "boolean", | |
| "readOnly": true | |
| }, | |
| "tags": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/TagDto" | |
| }, | |
| "readOnly": true | |
| }, | |
| "folderKeys": { | |
| "type": "array", | |
| "items": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "readOnly": true | |
| }, | |
| "eventTime": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "eventSource": {} | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "ApiTriggerDeletedEvent": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "enum": [ | |
| "Api", | |
| "Http" | |
| ], | |
| "type": "string", | |
| "readOnly": true, | |
| "x-ms-enum": { | |
| "name": "ApiTriggerDeletedEventType", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "Api", | |
| "Http" | |
| ] | |
| }, | |
| "organizationUnitFullyQualifiedName": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "externalReference": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "jobCount": { | |
| "format": "int32", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "jobPriority": { | |
| "format": "int32", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "requiresUserInteraction": { | |
| "type": "boolean" | |
| }, | |
| "alertPendingJobAfterSeconds": { | |
| "format": "int32", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "alertRunningJobAfterSeconds": { | |
| "format": "int32", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "stopJobAfterSeconds": { | |
| "format": "int32", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "killJobAfterSeconds": { | |
| "format": "int32", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "remoteControlAccess": { | |
| "enum": [ | |
| "None", | |
| "ReadOnly", | |
| "Full" | |
| ], | |
| "type": "string", | |
| "readOnly": true, | |
| "x-ms-enum": { | |
| "name": "ApiTriggerDeletedEventRemoteControlAccess", | |
| "modelAsString": false | |
| } | |
| }, | |
| "apiTriggerType": { | |
| "enum": [ | |
| "Manual", | |
| "IntegrationTrigger", | |
| "AutomationOpsPipelines" | |
| ], | |
| "type": "string", | |
| "readOnly": true, | |
| "x-ms-enum": { | |
| "name": "ApiTriggerDeletedEventApiTriggerType", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "Manual", | |
| "IntegrationTrigger", | |
| "AutomationOpsPipelines" | |
| ] | |
| }, | |
| "isConnected": { | |
| "type": "boolean", | |
| "readOnly": true | |
| }, | |
| "key": { | |
| "format": "uuid", | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "description": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "enabled": { | |
| "type": "boolean", | |
| "readOnly": true | |
| }, | |
| "releaseKey": { | |
| "format": "uuid", | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "runtimeType": { | |
| "enum": [ | |
| "NonProduction", | |
| "Attended", | |
| "Unattended", | |
| "Development", | |
| "Studio", | |
| "RpaDeveloper", | |
| "StudioX", | |
| "CitizenDeveloper", | |
| "Headless", | |
| "StudioPro", | |
| "RpaDeveloperPro", | |
| "TestAutomation", | |
| "AutomationCloud", | |
| "Serverless", | |
| "AutomationKit", | |
| "ServerlessTestAutomation", | |
| "AutomationCloudTestAutomation", | |
| "AttendedStudioWeb", | |
| "Hosting", | |
| "AssistantWeb", | |
| "ProcessOrchestration", | |
| "AgentService", | |
| "AppTest", | |
| "PerformanceTest", | |
| "BusinessRule", | |
| "CaseManagement" | |
| ], | |
| "type": "string", | |
| "readOnly": true, | |
| "x-ms-enum": { | |
| "name": "BaseTriggerEventRuntimeType", | |
| "modelAsString": false | |
| } | |
| }, | |
| "stopStrategy": { | |
| "enum": [ | |
| "SoftStop", | |
| "Kill" | |
| ], | |
| "type": "string", | |
| "readOnly": true, | |
| "x-ms-enum": { | |
| "name": "BaseTriggerEventStopStrategy", | |
| "modelAsString": false | |
| } | |
| }, | |
| "resumeOnSameContext": { | |
| "type": "boolean", | |
| "readOnly": true | |
| }, | |
| "consecutiveJobFailuresThreshold": { | |
| "format": "int32", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "jobFailuresGracePeriodInHours": { | |
| "format": "int32", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "runAsMe": { | |
| "type": "boolean", | |
| "readOnly": true | |
| }, | |
| "tags": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/TagDto" | |
| }, | |
| "readOnly": true | |
| }, | |
| "folderKeys": { | |
| "type": "array", | |
| "items": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "readOnly": true | |
| }, | |
| "eventTime": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "eventSource": {} | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "ApiTriggerUpdatedEvent": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "enum": [ | |
| "Api", | |
| "Http" | |
| ], | |
| "type": "string", | |
| "readOnly": true, | |
| "x-ms-enum": { | |
| "name": "ApiTriggerUpdatedEventType", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "Api", | |
| "Http" | |
| ] | |
| }, | |
| "organizationUnitFullyQualifiedName": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "externalReference": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "jobCount": { | |
| "format": "int32", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "jobPriority": { | |
| "format": "int32", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "requiresUserInteraction": { | |
| "type": "boolean" | |
| }, | |
| "alertPendingJobAfterSeconds": { | |
| "format": "int32", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "alertRunningJobAfterSeconds": { | |
| "format": "int32", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "stopJobAfterSeconds": { | |
| "format": "int32", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "killJobAfterSeconds": { | |
| "format": "int32", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "remoteControlAccess": { | |
| "enum": [ | |
| "None", | |
| "ReadOnly", | |
| "Full" | |
| ], | |
| "type": "string", | |
| "readOnly": true, | |
| "x-ms-enum": { | |
| "name": "ApiTriggerUpdatedEventRemoteControlAccess", | |
| "modelAsString": false | |
| } | |
| }, | |
| "apiTriggerType": { | |
| "enum": [ | |
| "Manual", | |
| "IntegrationTrigger", | |
| "AutomationOpsPipelines" | |
| ], | |
| "type": "string", | |
| "readOnly": true, | |
| "x-ms-enum": { | |
| "name": "ApiTriggerUpdatedEventApiTriggerType", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "Manual", | |
| "IntegrationTrigger", | |
| "AutomationOpsPipelines" | |
| ] | |
| }, | |
| "isConnected": { | |
| "type": "boolean", | |
| "readOnly": true | |
| }, | |
| "key": { | |
| "format": "uuid", | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "description": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "enabled": { | |
| "type": "boolean", | |
| "readOnly": true | |
| }, | |
| "releaseKey": { | |
| "format": "uuid", | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "runtimeType": { | |
| "enum": [ | |
| "NonProduction", | |
| "Attended", | |
| "Unattended", | |
| "Development", | |
| "Studio", | |
| "RpaDeveloper", | |
| "StudioX", | |
| "CitizenDeveloper", | |
| "Headless", | |
| "StudioPro", | |
| "RpaDeveloperPro", | |
| "TestAutomation", | |
| "AutomationCloud", | |
| "Serverless", | |
| "AutomationKit", | |
| "ServerlessTestAutomation", | |
| "AutomationCloudTestAutomation", | |
| "AttendedStudioWeb", | |
| "Hosting", | |
| "AssistantWeb", | |
| "ProcessOrchestration", | |
| "AgentService", | |
| "AppTest", | |
| "PerformanceTest", | |
| "BusinessRule", | |
| "CaseManagement" | |
| ], | |
| "type": "string", | |
| "readOnly": true, | |
| "x-ms-enum": { | |
| "name": "BaseTriggerEventRuntimeType", | |
| "modelAsString": false | |
| } | |
| }, | |
| "stopStrategy": { | |
| "enum": [ | |
| "SoftStop", | |
| "Kill" | |
| ], | |
| "type": "string", | |
| "readOnly": true, | |
| "x-ms-enum": { | |
| "name": "BaseTriggerEventStopStrategy", | |
| "modelAsString": false | |
| } | |
| }, | |
| "resumeOnSameContext": { | |
| "type": "boolean", | |
| "readOnly": true | |
| }, | |
| "consecutiveJobFailuresThreshold": { | |
| "format": "int32", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "jobFailuresGracePeriodInHours": { | |
| "format": "int32", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "runAsMe": { | |
| "type": "boolean", | |
| "readOnly": true | |
| }, | |
| "tags": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/TagDto" | |
| }, | |
| "readOnly": true | |
| }, | |
| "folderKeys": { | |
| "type": "array", | |
| "items": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "readOnly": true | |
| }, | |
| "eventTime": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "eventSource": {} | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "AppTasksCreateRequest": { | |
| "description": "Class with only attributes needed for Creating Task (TaskType = TaskType.AppTask)", | |
| "required": [ | |
| "appId", | |
| "appVersion", | |
| "title" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "taskDefinitionId": { | |
| "format": "int64", | |
| "description": "Id for associated task definition", | |
| "type": "integer" | |
| }, | |
| "taskDefinitionVersion": { | |
| "format": "int32", | |
| "description": "Version of Task Definition to get associated properties", | |
| "type": "integer" | |
| }, | |
| "appId": { | |
| "description": "Id representing AppId for AppTask", | |
| "maxLength": 34, | |
| "minLength": 1, | |
| "type": "string" | |
| }, | |
| "appVersion": { | |
| "format": "int32", | |
| "description": "Version of App for AppTask", | |
| "type": "integer" | |
| }, | |
| "appProcessKey": { | |
| "format": "uuid", | |
| "description": "Key associated with Apps", | |
| "type": "string" | |
| }, | |
| "folderKey": { | |
| "format": "uuid", | |
| "description": "Folder Key where App is deployed", | |
| "type": "string" | |
| }, | |
| "fpsContext": { | |
| "description": "FpsContext for Agent" | |
| }, | |
| "runtime": { | |
| "description": "Runtime type for deployed app", | |
| "enum": [ | |
| "Serverless", | |
| "Unattended" | |
| ], | |
| "type": "string", | |
| "x-ms-enum": { | |
| "name": "AppTasksCreateRequestRuntime", | |
| "modelAsString": false | |
| } | |
| }, | |
| "appType": { | |
| "description": "AppType - Custom or Dynamic", | |
| "enum": [ | |
| "Custom", | |
| "Dynamic" | |
| ], | |
| "type": "string", | |
| "x-ms-enum": { | |
| "name": "AppTasksCreateRequestAppType", | |
| "modelAsString": false | |
| } | |
| }, | |
| "isActionableMessageEnabled": { | |
| "description": "Is Acionable Message enabled", | |
| "type": "boolean" | |
| }, | |
| "actionableMessageMetaData": { | |
| "$ref": "#/definitions/ActionableMessageMetaData" | |
| }, | |
| "type": { | |
| "description": "Gets or sets type of this task, allowed type is 'ExternalTask'.", | |
| "enum": [ | |
| "FormTask", | |
| "ExternalTask", | |
| "DocumentValidationTask", | |
| "DocumentClassificationTask", | |
| "DataLabelingTask", | |
| "AppTask" | |
| ], | |
| "type": "string", | |
| "x-ms-enum": { | |
| "name": "TaskCreateRequestType", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "FormTask", | |
| "ExternalTask", | |
| "DocumentValidationTask", | |
| "DocumentClassificationTask", | |
| "DataLabelingTask", | |
| "AppTask" | |
| ] | |
| }, | |
| "title": { | |
| "description": "Gets or sets title of this task.", | |
| "maxLength": 512, | |
| "minLength": 0, | |
| "type": "string" | |
| }, | |
| "priority": { | |
| "description": "Gets or sets priority of this task.", | |
| "enum": [ | |
| "Low", | |
| "Medium", | |
| "High", | |
| "Critical" | |
| ], | |
| "type": "string", | |
| "x-ms-enum": { | |
| "name": "BaseTaskCreateRequestPriority", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "Low", | |
| "Medium", | |
| "High", | |
| "Critical" | |
| ] | |
| }, | |
| "data": { | |
| "description": "Task data" | |
| }, | |
| "taskCatalogName": { | |
| "description": "Gets or sets the task catalog/category of the task", | |
| "maxLength": 50, | |
| "type": "string" | |
| }, | |
| "externalTag": { | |
| "description": "Reference or name of external system", | |
| "maxLength": 512, | |
| "type": "string" | |
| }, | |
| "tags": { | |
| "description": "List of tags associated to the task.", | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/TagDto" | |
| } | |
| }, | |
| "parentOperationId": { | |
| "description": "Operation id which created the task.", | |
| "maxLength": 128, | |
| "minLength": 0, | |
| "type": "string" | |
| }, | |
| "taskSource": { | |
| "$ref": "#/definitions/TaskSourceDto" | |
| }, | |
| "taskAssignment": { | |
| "$ref": "#/definitions/TaskAssignmentData" | |
| }, | |
| "taskTimer": { | |
| "description": "Task Timer Configuration", | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/TaskTimerData" | |
| } | |
| } | |
| } | |
| }, | |
| "AppTasksDataDto": { | |
| "description": "Dto with attributes required for App Task", | |
| "type": "object", | |
| "properties": { | |
| "taskDefinitionPropertiesId": { | |
| "format": "int64", | |
| "description": "Task Definition Properties for App Task", | |
| "type": "integer" | |
| }, | |
| "appTasksMetadata": { | |
| "$ref": "#/definitions/AppTasksMetadataDto" | |
| }, | |
| "actionLabel": { | |
| "description": "App Task action label", | |
| "type": "string" | |
| }, | |
| "status": { | |
| "description": "Task status", | |
| "enum": [ | |
| "Unassigned", | |
| "Pending", | |
| "Completed" | |
| ], | |
| "type": "string", | |
| "x-ms-enum": { | |
| "name": "TaskDataDtoStatus", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "Unassigned", | |
| "Pending", | |
| "Completed" | |
| ] | |
| }, | |
| "data": { | |
| "description": "Task form data json" | |
| }, | |
| "action": { | |
| "description": "Task form action", | |
| "type": "string" | |
| }, | |
| "waitJobState": { | |
| "description": "State of the job(if any) waiting on the current task", | |
| "enum": [ | |
| "Pending", | |
| "Running", | |
| "Stopping", | |
| "Terminating", | |
| "Faulted", | |
| "Successful", | |
| "Stopped", | |
| "Suspended", | |
| "Resumed" | |
| ], | |
| "type": "string", | |
| "x-ms-enum": { | |
| "name": "TaskDataDtoWaitJobState", | |
| "modelAsString": false | |
| } | |
| }, | |
| "organizationUnitFullyQualifiedName": { | |
| "description": "Fully qualified folder name", | |
| "type": "string" | |
| }, | |
| "tags": { | |
| "description": "List of tags associated to the task.", | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/TagDto" | |
| } | |
| }, | |
| "assignedToUser": { | |
| "$ref": "#/definitions/UserLoginInfoDto" | |
| }, | |
| "taskSlaDetails": { | |
| "description": "Gets or sets the expiry time of Actionable Task Schedule", | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/TaskSlaDetailDto" | |
| } | |
| }, | |
| "completedByUser": { | |
| "$ref": "#/definitions/UserLoginInfoDto" | |
| }, | |
| "taskAssignmentCriteria": { | |
| "description": "Task status", | |
| "enum": [ | |
| "SingleUser", | |
| "Workload", | |
| "AllUsers", | |
| "RoundRobin", | |
| "Hierarchy" | |
| ], | |
| "type": "string", | |
| "x-ms-enum": { | |
| "name": "TaskDataDtoTaskAssignmentCriteria", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "SingleUser", | |
| "Workload", | |
| "AllUsers", | |
| "RoundRobin", | |
| "Hierarchy" | |
| ] | |
| }, | |
| "taskAssignees": { | |
| "description": "Gets or sets the list of users to whom task is assigned", | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/UserLoginInfoDto" | |
| } | |
| }, | |
| "isCurrentUserInAllUserAssignedGroup": { | |
| "type": "boolean" | |
| }, | |
| "taskSource": { | |
| "$ref": "#/definitions/TaskSourceDto" | |
| }, | |
| "processingTime": { | |
| "format": "int32", | |
| "description": "Time spent on the Task in assigned state", | |
| "type": "integer" | |
| }, | |
| "title": { | |
| "description": "Gets or sets title of this task.", | |
| "type": "string" | |
| }, | |
| "type": { | |
| "description": "Gets or sets type of this task.", | |
| "enum": [ | |
| "FormTask", | |
| "ExternalTask", | |
| "DocumentValidationTask", | |
| "DocumentClassificationTask", | |
| "DataLabelingTask", | |
| "AppTask" | |
| ], | |
| "type": "string", | |
| "x-ms-enum": { | |
| "name": "TaskMetadataDtoType", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "FormTask", | |
| "ExternalTask", | |
| "DocumentValidationTask", | |
| "DocumentClassificationTask", | |
| "DataLabelingTask", | |
| "AppTask" | |
| ] | |
| }, | |
| "priority": { | |
| "description": "Gets or sets priority of this task.", | |
| "enum": [ | |
| "Low", | |
| "Medium", | |
| "High", | |
| "Critical" | |
| ], | |
| "type": "string", | |
| "x-ms-enum": { | |
| "name": "TaskMetadataDtoPriority", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "Low", | |
| "Medium", | |
| "High", | |
| "Critical" | |
| ] | |
| }, | |
| "assignedToUserId": { | |
| "format": "int64", | |
| "description": "Gets the id of the actual assigned user, if any.", | |
| "type": "integer" | |
| }, | |
| "organizationUnitId": { | |
| "format": "int64", | |
| "description": "Gets or sets the folder/organization-unit id.", | |
| "type": "integer" | |
| }, | |
| "externalTag": { | |
| "description": "Identifier of external system where this task is handled", | |
| "type": "string" | |
| }, | |
| "creatorJobKey": { | |
| "format": "uuid", | |
| "description": "Key of the job which created this task", | |
| "type": "string" | |
| }, | |
| "waitJobKey": { | |
| "format": "uuid", | |
| "description": "Key job which is waiting on this task", | |
| "type": "string" | |
| }, | |
| "lastAssignedTime": { | |
| "format": "date-time", | |
| "description": "Datetime when task was last assigned.", | |
| "type": "string" | |
| }, | |
| "completionTime": { | |
| "format": "date-time", | |
| "description": "Datetime when task was completed.", | |
| "type": "string" | |
| }, | |
| "parentOperationId": { | |
| "description": "Operation id which created the task.", | |
| "type": "string" | |
| }, | |
| "key": { | |
| "format": "uuid", | |
| "description": "The unique Task identifier.", | |
| "type": "string" | |
| }, | |
| "isDeleted": { | |
| "type": "boolean" | |
| }, | |
| "deleterUserId": { | |
| "format": "int64", | |
| "type": "integer" | |
| }, | |
| "deletionTime": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "lastModificationTime": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "lastModifierUserId": { | |
| "format": "int64", | |
| "type": "integer" | |
| }, | |
| "creationTime": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "creatorUserId": { | |
| "format": "int64", | |
| "type": "integer" | |
| }, | |
| "id": { | |
| "format": "int64", | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "AppTasksMetadataDto": { | |
| "type": "object", | |
| "properties": { | |
| "appId": { | |
| "description": "Associated App Id for App Tasks", | |
| "type": "string" | |
| }, | |
| "appVersion": { | |
| "format": "int32", | |
| "description": "Associated App Version for App Tasks", | |
| "type": "integer" | |
| }, | |
| "appProcessKey": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "folderKey": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "fpsContext": {}, | |
| "runtime": { | |
| "enum": [ | |
| "Serverless", | |
| "Unattended" | |
| ], | |
| "type": "string", | |
| "x-ms-enum": { | |
| "name": "AppTasksMetadataDtoRuntime", | |
| "modelAsString": false | |
| } | |
| }, | |
| "appType": { | |
| "enum": [ | |
| "Custom", | |
| "Dynamic" | |
| ], | |
| "type": "string", | |
| "x-ms-enum": { | |
| "name": "AppTasksMetadataDtoAppType", | |
| "modelAsString": false | |
| } | |
| }, | |
| "creationTime": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "creatorUserId": { | |
| "format": "int64", | |
| "type": "integer" | |
| }, | |
| "creatorUserKey": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "id": { | |
| "format": "int64", | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "ArgumentMetadata": { | |
| "type": "object", | |
| "properties": { | |
| "Input": { | |
| "type": "string" | |
| }, | |
| "Output": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "AssetCreatedEvent": { | |
| "type": "object", | |
| "properties": { | |
| "key": { | |
| "format": "uuid", | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "description": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "valueScope": { | |
| "description": "Defines the visibility level of an asset.", | |
| "enum": [ | |
| "Global", | |
| "PerRobot" | |
| ], | |
| "type": "string", | |
| "readOnly": true, | |
| "x-ms-enum": { | |
| "name": "AssetCreatedEventValueScope", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "Global", | |
| "PerRobot" | |
| ] | |
| }, | |
| "valueType": { | |
| "description": "Defines what type of value is stored by an asset.", | |
| "enum": [ | |
| "DBConnectionString", | |
| "HttpConnectionString", | |
| "Text", | |
| "Bool", | |
| "Integer", | |
| "Credential", | |
| "WindowsCredential", | |
| "KeyValueList", | |
| "Secret" | |
| ], | |
| "type": "string", | |
| "readOnly": true, | |
| "x-ms-enum": { | |
| "name": "AssetCreatedEventValueType", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "DBConnectionString", | |
| "HttpConnectionString", | |
| "Text", | |
| "Bool", | |
| "Integer", | |
| "Credential", | |
| "WindowsCredential", | |
| "KeyValueList", | |
| "Secret" | |
| ] | |
| }, | |
| "tags": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/TagDto" | |
| }, | |
| "readOnly": true | |
| }, | |
| "folderKeys": { | |
| "type": "array", | |
| "items": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| }, | |
| "eventTime": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "eventSource": {} | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "AssetDeletedEvent": { | |
| "type": "object", | |
| "properties": { | |
| "key": { | |
| "format": "uuid", | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "description": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "valueScope": { | |
| "description": "Defines the visibility level of an asset.", | |
| "enum": [ | |
| "Global", | |
| "PerRobot" | |
| ], | |
| "type": "string", | |
| "readOnly": true, | |
| "x-ms-enum": { | |
| "name": "AssetDeletedEventValueScope", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "Global", | |
| "PerRobot" | |
| ] | |
| }, | |
| "valueType": { | |
| "description": "Defines what type of value is stored by an asset.", | |
| "enum": [ | |
| "DBConnectionString", | |
| "HttpConnectionString", | |
| "Text", | |
| "Bool", | |
| "Integer", | |
| "Credential", | |
| "WindowsCredential", | |
| "KeyValueList", | |
| "Secret" | |
| ], | |
| "type": "string", | |
| "readOnly": true, | |
| "x-ms-enum": { | |
| "name": "AssetDeletedEventValueType", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "DBConnectionString", | |
| "HttpConnectionString", | |
| "Text", | |
| "Bool", | |
| "Integer", | |
| "Credential", | |
| "WindowsCredential", | |
| "KeyValueList", | |
| "Secret" | |
| ] | |
| }, | |
| "folderKeys": { | |
| "type": "array", | |
| "items": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| }, | |
| "eventTime": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "eventSource": {} | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "AssetDto": { | |
| "description": "Stores specific data so that robots can easily have access to it.", | |
| "required": [ | |
| "Name", | |
| "ValueScope" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "Key": { | |
| "format": "uuid", | |
| "description": "An unique identifier", | |
| "type": "string" | |
| }, | |
| "Name": { | |
| "description": "A custom name for the asset.", | |
| "maxLength": 256, | |
| "minLength": 1, | |
| "type": "string" | |
| }, | |
| "CanBeDeleted": { | |
| "description": "States if an assets can be deleted. The default value of this property is true.", | |
| "type": "boolean" | |
| }, | |
| "ValueScope": { | |
| "description": "Defines the scope of the asset.", | |
| "enum": [ | |
| "Global", | |
| "PerRobot" | |
| ], | |
| "type": "string", | |
| "x-ms-enum": { | |
| "name": "AssetDtoValueScope", | |
| "modelAsString": true | |
| }, | |
| "x-enum-varnames": [ | |
| "Global", | |
| "PerRobot" | |
| ] | |
| }, | |
| "ValueType": { | |
| "description": "Defines the type of value stored by the asset.", | |
| "enum": [ | |
| "DBConnectionString", | |
| "HttpConnectionString", | |
| "Text", | |
| "Bool", | |
| "Integer", | |
| "Credential", | |
| "WindowsCredential", | |
| "KeyValueList", | |
| "Secret" | |
| ], | |
| "type": "string", | |
| "x-ms-enum": { | |
| "name": "AssetDtoValueType", | |
| "modelAsString": true | |
| }, | |
| "x-enum-varnames": [ | |
| "DBConnectionString", | |
| "HttpConnectionString", | |
| "Text", | |
| "Bool", | |
| "Integer", | |
| "Credential", | |
| "WindowsCredential", | |
| "KeyValueList", | |
| "Secret" | |
| ] | |
| }, | |
| "Value": { | |
| "description": "The textual representation of the asset value, irrespective of value type.", | |
| "type": "string" | |
| }, | |
| "StringValue": { | |
| "description": "The value of the asset when the value type is Text. Empty when the value type is not Text.", | |
| "maxLength": 1000000, | |
| "type": "string" | |
| }, | |
| "BoolValue": { | |
| "description": "The value of the asset when the value type is Bool. False when the value type is not Bool.", | |
| "type": "boolean" | |
| }, | |
| "IntValue": { | |
| "format": "int32", | |
| "description": "The value of the asset when the value type is Integer. 0 when the value type is not Integer.", | |
| "type": "integer" | |
| }, | |
| "CredentialUsername": { | |
| "description": "The user name when the value type is Credential. Empty when the value type is not Credential.", | |
| "maxLength": 512, | |
| "type": "string" | |
| }, | |
| "CredentialPassword": { | |
| "description": "The password when the value type is Credential. Empty when the value type is not Credential.", | |
| "maxLength": 25000, | |
| "type": "string" | |
| }, | |
| "SecretValue": { | |
| "description": "The value of the asset when the value type is Secret. Empty when the value is not Secret", | |
| "maxLength": 25000, | |
| "type": "string" | |
| }, | |
| "ExternalName": { | |
| "description": "Contains the value of the key in the external store used to store the credentials.", | |
| "maxLength": 450, | |
| "minLength": 0, | |
| "type": "string" | |
| }, | |
| "CredentialStoreId": { | |
| "format": "int64", | |
| "description": "The Credential Store used to store the credentials.", | |
| "type": "integer" | |
| }, | |
| "KeyValueList": { | |
| "description": "A collection of key value pairs when the type is KeyValueList. Empty when the value type is not KeyValueList.", | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/CustomKeyValuePair" | |
| } | |
| }, | |
| "HasDefaultValue": { | |
| "description": "The asset has a default value set. This value will be null when set from legacy components that don't support\r\nthe PerRobot assets with default value feature.", | |
| "type": "boolean" | |
| }, | |
| "Description": { | |
| "description": "The description of the asset.", | |
| "maxLength": 250, | |
| "type": "string" | |
| }, | |
| "RobotValues": { | |
| "description": "DEPRECATED. The collection of asset values per robot. Empty if the asset type is Global or PerUser.", | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/AssetRobotValueDto" | |
| }, | |
| "x-deprecated": true | |
| }, | |
| "UserValues": { | |
| "description": "The collection of asset values per user. Empty if the asset type is Global or PerRobot.", | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/AssetUserValueDto" | |
| } | |
| }, | |
| "Tags": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/TagDto" | |
| } | |
| }, | |
| "FoldersCount": { | |
| "format": "int32", | |
| "description": "Number of folders where the asset is shared.", | |
| "type": "integer" | |
| }, | |
| "LastModificationTime": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "LastModifierUserId": { | |
| "format": "int64", | |
| "type": "integer" | |
| }, | |
| "CreationTime": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "CreatorUserId": { | |
| "format": "int64", | |
| "type": "integer" | |
| }, | |
| "Id": { | |
| "format": "int64", | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "AssetFoldersShareDto": { | |
| "type": "object", | |
| "properties": { | |
| "AssetIds": { | |
| "type": "array", | |
| "items": { | |
| "format": "int64", | |
| "type": "integer" | |
| } | |
| }, | |
| "ToAddFolderIds": { | |
| "type": "array", | |
| "items": { | |
| "format": "int64", | |
| "type": "integer" | |
| } | |
| }, | |
| "ToRemoveFolderIds": { | |
| "type": "array", | |
| "items": { | |
| "format": "int64", | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "AssetRobotValueDto": { | |
| "description": "Stores the value of an asset associated with a robot as well as the robot association data.", | |
| "type": "object", | |
| "properties": { | |
| "Name": { | |
| "description": "Name of the asset", | |
| "type": "string" | |
| }, | |
| "RobotId": { | |
| "format": "int64", | |
| "description": "The Id of the robot with which the asset is associated.", | |
| "type": "integer" | |
| }, | |
| "RobotName": { | |
| "description": "The name of the robot with which the asset is associated.", | |
| "type": "string" | |
| }, | |
| "KeyTrail": { | |
| "description": "Masked value of the robot key.", | |
| "type": "string" | |
| }, | |
| "ValueType": { | |
| "description": "Defines the type of value stored by the asset.", | |
| "enum": [ | |
| "DBConnectionString", | |
| "HttpConnectionString", | |
| "Text", | |
| "Bool", | |
| "Integer", | |
| "Credential", | |
| "WindowsCredential", | |
| "KeyValueList", | |
| "Secret" | |
| ], | |
| "type": "string", | |
| "x-ms-enum": { | |
| "name": "AssetRobotValueDtoValueType", | |
| "modelAsString": true | |
| }, | |
| "x-enum-varnames": [ | |
| "DBConnectionString", | |
| "HttpConnectionString", | |
| "Text", | |
| "Bool", | |
| "Integer", | |
| "Credential", | |
| "WindowsCredential", | |
| "KeyValueList", | |
| "Secret" | |
| ] | |
| }, | |
| "StringValue": { | |
| "description": "The value of the asset when the value type is Text. Empty when the value type is not Text.", | |
| "maxLength": 1000000, | |
| "type": "string" | |
| }, | |
| "BoolValue": { | |
| "description": "The value of the asset when the value type is Bool. False when the value type is not Bool.", | |
| "type": "boolean" | |
| }, | |
| "IntValue": { | |
| "format": "int32", | |
| "description": "The value of the asset when the value type is Integer. 0 when the value type is not Integer.", | |
| "type": "integer" | |
| }, | |
| "SecretValue": { | |
| "description": "The value of the asset when the value type is Secret. Empty when the value is not Secret", | |
| "type": "string" | |
| }, | |
| "Value": { | |
| "description": "The textual representation of the asset value, irrespective of value type.", | |
| "type": "string" | |
| }, | |
| "CredentialUsername": { | |
| "description": "The user name when the value type is Credential. Empty when the value type is not Credential.", | |
| "type": "string" | |
| }, | |
| "CredentialPassword": { | |
| "description": "The password when the value type is Credential. Empty when the value type is not Credential.", | |
| "type": "string" | |
| }, | |
| "ExternalName": { | |
| "description": "Contains the value of the key in the external store used to store the credentials.", | |
| "maxLength": 450, | |
| "minLength": 0, | |
| "type": "string" | |
| }, | |
| "CredentialStoreId": { | |
| "format": "int64", | |
| "description": "The Credential Store used to store the credentials.", | |
| "type": "integer" | |
| }, | |
| "KeyValueList": { | |
| "description": "A collection of key value pairs when the type is KeyValueList. Empty when the value type is not KeyValueList.", | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/CustomKeyValuePair" | |
| } | |
| }, | |
| "Id": { | |
| "format": "int64", | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "AssetUpdatedEvent": { | |
| "type": "object", | |
| "properties": { | |
| "key": { | |
| "format": "uuid", | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "description": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "valueScope": { | |
| "description": "Defines the visibility level of an asset.", | |
| "enum": [ | |
| "Global", | |
| "PerRobot" | |
| ], | |
| "type": "string", | |
| "readOnly": true, | |
| "x-ms-enum": { | |
| "name": "AssetUpdatedEventValueScope", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "Global", | |
| "PerRobot" | |
| ] | |
| }, | |
| "valueType": { | |
| "description": "Defines what type of value is stored by an asset.", | |
| "enum": [ | |
| "DBConnectionString", | |
| "HttpConnectionString", | |
| "Text", | |
| "Bool", | |
| "Integer", | |
| "Credential", | |
| "WindowsCredential", | |
| "KeyValueList", | |
| "Secret" | |
| ], | |
| "type": "string", | |
| "readOnly": true, | |
| "x-ms-enum": { | |
| "name": "AssetUpdatedEventValueType", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "DBConnectionString", | |
| "HttpConnectionString", | |
| "Text", | |
| "Bool", | |
| "Integer", | |
| "Credential", | |
| "WindowsCredential", | |
| "KeyValueList", | |
| "Secret" | |
| ] | |
| }, | |
| "tags": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/TagDto" | |
| }, | |
| "readOnly": true | |
| }, | |
| "folderKeys": { | |
| "type": "array", | |
| "items": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| }, | |
| "eventTime": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "eventSource": {} | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "AssetUserValueDto": { | |
| "description": "Stores the value of an asset associated with a user.", | |
| "type": "object", | |
| "properties": { | |
| "Name": { | |
| "description": "The name of the asset", | |
| "type": "string" | |
| }, | |
| "UserId": { | |
| "format": "int64", | |
| "description": "The Id of the user with which the asset is associated.", | |
| "type": "integer" | |
| }, | |
| "UserName": { | |
| "description": "The name of the user which the asset is associated.", | |
| "type": "string" | |
| }, | |
| "MachineId": { | |
| "format": "int64", | |
| "description": "The Id of the machine which the asset is associated", | |
| "type": "integer" | |
| }, | |
| "MachineName": { | |
| "description": "The name of the machine which the asset is associated.", | |
| "type": "string" | |
| }, | |
| "ValueType": { | |
| "description": "Defines the type of value stored by the asset.", | |
| "enum": [ | |
| "DBConnectionString", | |
| "HttpConnectionString", | |
| "Text", | |
| "Bool", | |
| "Integer", | |
| "Credential", | |
| "WindowsCredential", | |
| "KeyValueList", | |
| "Secret" | |
| ], | |
| "type": "string", | |
| "x-ms-enum": { | |
| "name": "AssetUserValueDtoValueType", | |
| "modelAsString": true | |
| }, | |
| "x-enum-varnames": [ | |
| "DBConnectionString", | |
| "HttpConnectionString", | |
| "Text", | |
| "Bool", | |
| "Integer", | |
| "Credential", | |
| "WindowsCredential", | |
| "KeyValueList", | |
| "Secret" | |
| ] | |
| }, | |
| "StringValue": { | |
| "description": "The value of the asset when the value type is Text. Empty when the value type is not Text.", | |
| "maxLength": 1000000, | |
| "type": "string" | |
| }, | |
| "BoolValue": { | |
| "description": "The value of the asset when the value type is Bool. False when the value type is not Bool.", | |
| "type": "boolean" | |
| }, | |
| "IntValue": { | |
| "format": "int32", | |
| "description": "The value of the asset when the value type is Integer. 0 when the value type is not Integer.", | |
| "type": "integer" | |
| }, | |
| "Value": { | |
| "description": "The textual representation of the asset value, irrespective of value type.", | |
| "type": "string" | |
| }, | |
| "CredentialUsername": { | |
| "description": "The user name when the value type is Credential. Empty when the value type is not Credential.", | |
| "type": "string" | |
| }, | |
| "CredentialPassword": { | |
| "description": "The password when the value type is Credential. Empty when the value type is not Credential.", | |
| "type": "string" | |
| }, | |
| "SecretValue": { | |
| "description": "The value of the asset when the value type is Secret. Empty when the value is not Secret", | |
| "type": "string" | |
| }, | |
| "CredentialStoreId": { | |
| "format": "int64", | |
| "description": "The Credential Store used to store the credentials.", | |
| "type": "integer" | |
| }, | |
| "ExternalName": { | |
| "description": "Contains the value of the key in the external store used to store the credentials.", | |
| "maxLength": 450, | |
| "minLength": 0, | |
| "type": "string" | |
| }, | |
| "KeyValueList": { | |
| "description": "A collection of key value pairs when the type is KeyValueList. Empty when the value type is not KeyValueList.", | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/CustomKeyValuePair" | |
| } | |
| }, | |
| "Id": { | |
| "format": "int64", | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "AssetsGetRobotByNameAndKeyRequest": { | |
| "required": [ | |
| "assetName" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "robotKey": { | |
| "type": "string" | |
| }, | |
| "assetName": { | |
| "minLength": 1, | |
| "type": "string" | |
| }, | |
| "supportsCredentialsProxyDisconnected": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "AssetsSetRobotAssetsByKeyRequest": { | |
| "required": [ | |
| "robotAsset", | |
| "robotKey" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "robotKey": { | |
| "minLength": 1, | |
| "type": "string" | |
| }, | |
| "robotAsset": { | |
| "$ref": "#/definitions/UserAssetDto" | |
| } | |
| } | |
| }, | |
| "AttachmentDto": { | |
| "required": [ | |
| "Name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "Name": { | |
| "maxLength": 256, | |
| "minLength": 1, | |
| "type": "string" | |
| }, | |
| "JobKey": { | |
| "format": "uuid", | |
| "description": "Optional job key to link the attachment to a job when creating it.\r\nThis field is only used for input and is not returned in responses.", | |
| "type": "string" | |
| }, | |
| "AttachmentCategory": { | |
| "description": "Optional category for the attachment when linking to a job.\r\nThis field is only used for input and is not returned in responses.", | |
| "maxLength": 128, | |
| "type": "string" | |
| }, | |
| "LastModificationTime": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "LastModifierUserId": { | |
| "format": "int64", | |
| "type": "integer" | |
| }, | |
| "CreationTime": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "CreatorUserId": { | |
| "format": "int64", | |
| "type": "integer" | |
| }, | |
| "Id": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "AttendedRobotDto": { | |
| "type": "object", | |
| "properties": { | |
| "UserName": { | |
| "description": "The UserName used to authenticate on the Host Machine.", | |
| "maxLength": 100, | |
| "minLength": 0, | |
| "type": "string" | |
| }, | |
| "ExecutionSettings": { | |
| "description": "An object containing execution settings for the Robot.", | |
| "type": "object", | |
| "additionalProperties": {} | |
| }, | |
| "RobotId": { | |
| "format": "int64", | |
| "description": "The actual Id of the provisioned Robot.", | |
| "type": "integer" | |
| }, | |
| "RobotType": { | |
| "description": "The actual Type of the provisioned Robot.", | |
| "enum": [ | |
| "NonProduction", | |
| "Attended", | |
| "Unattended", | |
| "Development", | |
| "Studio", | |
| "RpaDeveloper", | |
| "StudioX", | |
| "CitizenDeveloper", | |
| "Headless", | |
| "StudioPro", | |
| "RpaDeveloperPro", | |
| "TestAutomation", | |
| "AutomationCloud", | |
| "Serverless", | |
| "AutomationKit", | |
| "ServerlessTestAutomation", | |
| "AutomationCloudTestAutomation", | |
| "AttendedStudioWeb", | |
| "Hosting", | |
| "AssistantWeb", | |
| "ProcessOrchestration", | |
| "AgentService", | |
| "AppTest", | |
| "PerformanceTest", | |
| "BusinessRule", | |
| "CaseManagement" | |
| ], | |
| "type": "string", | |
| "x-ms-enum": { | |
| "name": "AttendedRobotDtoRobotType", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "NonProduction", | |
| "Attended", | |
| "Unattended", | |
| "Development", | |
| "Studio", | |
| "RpaDeveloper", | |
| "StudioX", | |
| "CitizenDeveloper", | |
| "Headless", | |
| "StudioPro", | |
| "RpaDeveloperPro", | |
| "TestAutomation", | |
| "AutomationCloud", | |
| "Serverless", | |
| "AutomationKit", | |
| "ServerlessTestAutomation", | |
| "AutomationCloudTestAutomation", | |
| "AttendedStudioWeb", | |
| "Hosting", | |
| "AssistantWeb", | |
| "ProcessOrchestration", | |
| "AgentService", | |
| "AppTest", | |
| "PerformanceTest", | |
| "BusinessRule", | |
| "CaseManagement" | |
| ] | |
| } | |
| } | |
| }, | |
| "AuditLogDto": { | |
| "description": "Stores audit information about any action performed in Orchestrator.", | |
| "type": "object", | |
| "properties": { | |
| "ServiceName": { | |
| "description": "The name of the Orchestrator service that performed a given action in the system.", | |
| "type": "string" | |
| }, | |
| "MethodName": { | |
| "description": "The name of the service method that performed a given action in the system.", | |
| "type": "string" | |
| }, | |
| "Parameters": { | |
| "description": "JSON representation of the method parameters and their values for the given action.", | |
| "type": "string" | |
| }, | |
| "ExecutionTime": { | |
| "format": "date-time", | |
| "description": "The date and time when the action was performed.", | |
| "type": "string" | |
| }, | |
| "Action": { | |
| "description": "The action performed (create, update, delete etc)", | |
| "enum": [ | |
| "Unknown", | |
| "Create", | |
| "Update", | |
| "Delete", | |
| "StartJob", | |
| "StopJob", | |
| "Associate", | |
| "Upload", | |
| "ChangeStatus", | |
| "Import", | |
| "ChangePassword", | |
| "Register", | |
| "Toggle", | |
| "ResetPassword", | |
| "PasswordResetAttempt", | |
| "Download", | |
| "Acknowledge", | |
| "Activate", | |
| "Assign", | |
| "BulkUpload", | |
| "UpdateFeature", | |
| "ResumeJob", | |
| "Start", | |
| "End", | |
| "Skip", | |
| "Unassign", | |
| "Deactivate", | |
| "CreateBlobFileSas", | |
| "DeleteBlobFile", | |
| "Move", | |
| "Set", | |
| "StartDelete", | |
| "ExploreStart", | |
| "ExploreEnd", | |
| "Save", | |
| "Convert", | |
| "Forward", | |
| "BulkComplete", | |
| "BulkSave", | |
| "ForceStopJob", | |
| "MigrateFolder", | |
| "EditTaskMetadata", | |
| "Archive", | |
| "StartMigrateFolders", | |
| "ToggleUserFolderSubscription", | |
| "StartUninstall", | |
| "StartInstall", | |
| "VideoAccess", | |
| "AutomaticallyExploreEnd", | |
| "InstallState", | |
| "FinishInstall", | |
| "FinishUninstall" | |
| ], | |
| "type": "string", | |
| "x-ms-enum": { | |
| "name": "AuditLogDtoAction", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "Unknown", | |
| "Create", | |
| "Update", | |
| "Delete", | |
| "StartJob", | |
| "StopJob", | |
| "Associate", | |
| "Upload", | |
| "ChangeStatus", | |
| "Import", | |
| "ChangePassword", | |
| "Register", | |
| "Toggle", | |
| "ResetPassword", | |
| "PasswordResetAttempt", | |
| "Download", | |
| "Acknowledge", | |
| "Activate", | |
| "Assign", | |
| "BulkUpload", | |
| "UpdateFeature", | |
| "ResumeJob", | |
| "Start", | |
| "End", | |
| "Skip", | |
| "Unassign", | |
| "Deactivate", | |
| "CreateBlobFileSas", | |
| "DeleteBlobFile", | |
| "Move", | |
| "Set", | |
| "StartDelete", | |
| "ExploreStart", | |
| "ExploreEnd", | |
| "Save", | |
| "Convert", | |
| "Forward", | |
| "BulkComplete", | |
| "BulkSave", | |
| "ForceStopJob", | |
| "MigrateFolder", | |
| "EditTaskMetadata", | |
| "Archive", | |
| "StartMigrateFolders", | |
| "ToggleUserFolderSubscription", | |
| "StartUninstall", | |
| "StartInstall", | |
| "VideoAccess", | |
| "AutomaticallyExploreEnd", | |
| "InstallState", | |
| "FinishInstall", | |
| "FinishUninstall" | |
| ] | |
| }, | |
| "Component": { | |
| "description": "The component for which the action was performed", | |
| "enum": [ | |
| "Unknown", | |
| "Assets", | |
| "Environments", | |
| "Processes", | |
| "Queues", | |
| "Robots", | |
| "Roles", | |
| "Schedules", | |
| "Users", | |
| "Comments", | |
| "Units", | |
| "Jobs", | |
| "Settings", | |
| "Packages", | |
| "License", | |
| "Tenant", | |
| "Machines", | |
| "Libraries", | |
| "Webhooks", | |
| "ExecutionMedia", | |
| "Monitoring", | |
| "CredentialStores", | |
| "DefaultCredentialStores", | |
| "TaskCatalogs", | |
| "Tasks", | |
| "Maintenance", | |
| "Folders", | |
| "DirectoryService", | |
| "Buckets", | |
| "Secrets", | |
| "PersonalWorkspaces", | |
| "CloudSubscriptions", | |
| "CloudSnapshots", | |
| "Sessions", | |
| "CredentialsProxies", | |
| "StudioWeb", | |
| "AutomationSolutions", | |
| "RemoteControl", | |
| "TaskSolutions", | |
| "TaskDefinitions", | |
| "HttpTriggers", | |
| "AutopilotForRobotsData", | |
| "BusinessRules", | |
| "IntegrationTriggers", | |
| "JobAttachments", | |
| "TestSets", | |
| "TestSetSchedules", | |
| "TestDataQueues", | |
| "TestDataQueueItems" | |
| ], | |
| "type": "string", | |
| "x-ms-enum": { | |
| "name": "AuditLogDtoComponent", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "Unknown", | |
| "Assets", | |
| "Environments", | |
| "Processes", | |
| "Queues", | |
| "Robots", | |
| "Roles", | |
| "Schedules", | |
| "Users", | |
| "Comments", | |
| "Units", | |
| "Jobs", | |
| "Settings", | |
| "Packages", | |
| "License", | |
| "Tenant", | |
| "Machines", | |
| "Libraries", | |
| "Webhooks", | |
| "ExecutionMedia", | |
| "Monitoring", | |
| "CredentialStores", | |
| "DefaultCredentialStores", | |
| "TaskCatalogs", | |
| "Tasks", | |
| "Maintenance", | |
| "Folders", | |
| "DirectoryService", | |
| "Buckets", | |
| "Secrets", | |
| "PersonalWorkspaces", | |
| "CloudSubscriptions", | |
| "CloudSnapshots", | |
| "Sessions", | |
| "CredentialsProxies", | |
| "StudioWeb", | |
| "AutomationSolutions", | |
| "RemoteControl", | |
| "TaskSolutions", | |
| "TaskDefinitions", | |
| "HttpTriggers", | |
| "AutopilotForRobotsData", | |
| "BusinessRules", | |
| "IntegrationTriggers", | |
| "JobAttachments", | |
| "TestSets", | |
| "TestSetSchedules", | |
| "TestDataQueues", | |
| "TestDataQueueItems" | |
| ] | |
| }, | |
| "DisplayName": { | |
| "description": "The display name of the resource acted on, usually Name", | |
| "type": "string" | |
| }, | |
| "EntityId": { | |
| "format": "int64", | |
| "description": "The Id of the resource acted on", | |
| "type": "integer" | |
| }, | |
| "OperationText": { | |
| "description": "User friendly description of the change, e.g. \"User X created robot Y\"", | |
| "type": "string" | |
| }, | |
| "UserName": { | |
| "description": "UserName that sent the request", | |
| "type": "string" | |
| }, | |
| "UserType": { | |
| "description": "The type of user that sent the request", | |
| "enum": [ | |
| "User", | |
| "Robot", | |
| "DirectoryUser", | |
| "DirectoryGroup", | |
| "DirectoryRobot", | |
| "DirectoryExternalApplication" | |
| ], | |
| "type": "string", | |
| "x-ms-enum": { | |
| "name": "AuditLogDtoUserType", | |
| "modelAsString": false | |
| } | |
| }, | |
| "Entities": { | |
| "description": "Audit entity details collection", | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/AuditLogEntityDto" | |
| } | |
| }, | |
| "ExternalClientId": { | |
| "description": "External client identifier. Example: OAuth 3rd party app identifier that called Orchestrator.", | |
| "type": "string" | |
| }, | |
| "UserId": { | |
| "format": "int64", | |
| "type": "integer" | |
| }, | |
| "UserIsDeleted": { | |
| "description": "Marks whether the users that did the action was deleted in the meantime", | |
| "type": "boolean" | |
| }, | |
| "Id": { | |
| "format": "int64", | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "AuditLogEntityDto": { | |
| "description": "Stores audit information about any action performed in Orchestrator.", | |
| "type": "object", | |
| "properties": { | |
| "AuditLogId": { | |
| "format": "int64", | |
| "description": "Business audit entry that triggered the changes", | |
| "type": "integer" | |
| }, | |
| "CustomData": { | |
| "description": "Data about the old/new/included values", | |
| "type": "string" | |
| }, | |
| "EntityId": { | |
| "format": "int64", | |
| "description": "The Id of the referred entity", | |
| "type": "integer" | |
| }, | |
| "EntityName": { | |
| "description": "The name of the entity the auditLog refers to", | |
| "type": "string" | |
| }, | |
| "Action": { | |
| "description": "The action (created, updated, deleted etc)", | |
| "enum": [ | |
| "Unknown", | |
| "Create", | |
| "Update", | |
| "Delete", | |
| "StartJob", | |
| "StopJob", | |
| "Associate", | |
| "Upload", | |
| "ChangeStatus", | |
| "Import", | |
| "ChangePassword", | |
| "Register", | |
| "Toggle", | |
| "ResetPassword", | |
| "PasswordResetAttempt", | |
| "Download", | |
| "Acknowledge", | |
| "Activate", | |
| "Assign", | |
| "BulkUpload", | |
| "UpdateFeature", | |
| "ResumeJob", | |
| "Start", | |
| "End", | |
| "Skip", | |
| "Unassign", | |
| "Deactivate", | |
| "CreateBlobFileSas", | |
| "DeleteBlobFile", | |
| "Move", | |
| "Set", | |
| "StartDelete", | |
| "ExploreStart", | |
| "ExploreEnd", | |
| "Save", | |
| "Convert", | |
| "Forward", | |
| "BulkComplete", | |
| "BulkSave", | |
| "ForceStopJob", | |
| "MigrateFolder", | |
| "EditTaskMetadata", | |
| "Archive", | |
| "StartMigrateFolders", | |
| "ToggleUserFolderSubscription", | |
| "StartUninstall", | |
| "StartInstall", | |
| "VideoAccess", | |
| "AutomaticallyExploreEnd", | |
| "InstallState", | |
| "FinishInstall", | |
| "FinishUninstall" | |
| ], | |
| "type": "string", | |
| "x-ms-enum": { | |
| "name": "AuditLogEntityDtoAction", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "Unknown", | |
| "Create", | |
| "Update", | |
| "Delete", | |
| "StartJob", | |
| "StopJob", | |
| "Associate", | |
| "Upload", | |
| "ChangeStatus", | |
| "Import", | |
| "ChangePassword", | |
| "Register", | |
| "Toggle", | |
| "ResetPassword", | |
| "PasswordResetAttempt", | |
| "Download", | |
| "Acknowledge", | |
| "Activate", | |
| "Assign", | |
| "BulkUpload", | |
| "UpdateFeature", | |
| "ResumeJob", | |
| "Start", | |
| "End", | |
| "Skip", | |
| "Unassign", | |
| "Deactivate", | |
| "CreateBlobFileSas", | |
| "DeleteBlobFile", | |
| "Move", | |
| "Set", | |
| "StartDelete", | |
| "ExploreStart", | |
| "ExploreEnd", | |
| "Save", | |
| "Convert", | |
| "Forward", | |
| "BulkComplete", | |
| "BulkSave", | |
| "ForceStopJob", | |
| "MigrateFolder", | |
| "EditTaskMetadata", | |
| "Archive", | |
| "StartMigrateFolders", | |
| "ToggleUserFolderSubscription", | |
| "StartUninstall", | |
| "StartInstall", | |
| "VideoAccess", | |
| "AutomaticallyExploreEnd", | |
| "InstallState", | |
| "FinishInstall", | |
| "FinishUninstall" | |
| ] | |
| }, | |
| "Id": { | |
| "format": "int64", | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "AutopilotForRobotsSettingsDto": { | |
| "type": "object", | |
| "properties": { | |
| "Enabled": { | |
| "type": "boolean" | |
| }, | |
| "HealingEnabled": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "BlobFileAccessDto": { | |
| "type": "object", | |
| "properties": { | |
| "Uri": { | |
| "type": "string" | |
| }, | |
| "Verb": { | |
| "type": "string" | |
| }, | |
| "RequiresAuth": { | |
| "type": "boolean" | |
| }, | |
| "Headers": { | |
| "$ref": "#/definitions/ResponseDictionaryDto" | |
| } | |
| } | |
| }, | |
| "BlobFileDeletedEvent": { | |
| "required": [ | |
| "EventId", | |
| "Timestamp", | |
| "Type" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "Type": { | |
| "minLength": 1, | |
| "type": "string" | |
| }, | |
| "EventId": { | |
| "maxLength": 50, | |
| "minLength": 0, | |
| "type": "string" | |
| }, | |
| "EntityKey": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "Timestamp": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "BucketName": { | |
| "type": "string" | |
| }, | |
| "FullPath": { | |
| "type": "string" | |
| }, | |
| "EventTime": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "EventSourceId": { | |
| "format": "int64", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "TenantId": { | |
| "format": "int32", | |
| "type": "integer" | |
| }, | |
| "OrganizationUnitId": { | |
| "format": "int64", | |
| "type": "integer" | |
| }, | |
| "OrganizationUnitKey": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "UserKey": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "UserId": { | |
| "format": "int64", | |
| "type": "integer" | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "x-webhook-event": "blobfile.deleted" | |
| }, | |
| "BlobFileDto": { | |
| "type": "object", | |
| "properties": { | |
| "FullPath": { | |
| "type": "string" | |
| }, | |
| "ContentType": { | |
| "type": "string" | |
| }, | |
| "Size": { | |
| "format": "int64", | |
| "type": "integer" | |
| }, | |
| "IsDirectory": { | |
| "type": "boolean" | |
| }, | |
| "Id": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "BlobFileUploadedEvent": { | |
| "required": [ | |
| "EventId", | |
| "Timestamp", | |
| "Type" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "Type": { | |
| "minLength": 1, | |
| "type": "string" | |
| }, | |
| "EventId": { | |
| "maxLength": 50, | |
| "minLength": 0, | |
| "type": "string" | |
| }, | |
| "EntityKey": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "Timestamp": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "BucketName": { | |
| "type": "string" | |
| }, | |
| "FullPath": { | |
| "type": "string" | |
| }, | |
| "EventTime": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "EventSourceId": { | |
| "format": "int64", | |
| "type": "integer", | |
| "readOnly": true | |
| }, | |
| "TenantId": { | |
| "format": "int32", | |
| "type": "integer" | |
| }, | |
| "OrganizationUnitId": { | |
| "format": "int64", | |
| "type": "integer" | |
| }, | |
| "OrganizationUnitKey": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "UserKey": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "UserId": { | |
| "format": "int64", | |
| "type": "integer" | |
| } | |
| }, | |
| "additionalProperties": false, | |
| "x-webhook-event": "blobfile.uploaded" | |
| }, | |
| "BlobItemDto": { | |
| "type": "object", | |
| "properties": { | |
| "fullPath": { | |
| "type": "string" | |
| }, | |
| "contentType": { | |
| "type": "string" | |
| }, | |
| "size": { | |
| "format": "int64", | |
| "type": "integer" | |
| }, | |
| "lastModified": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "accessInfo": { | |
| "$ref": "#/definitions/BlobFileAccessDto" | |
| } | |
| } | |
| }, | |
| "BucketCreatedEvent": { | |
| "type": "object", | |
| "properties": { | |
| "key": { | |
| "format": "uuid", | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "description": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "storageProvider": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "storageParameters": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "storageContainer": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "options": { | |
| "enum": [ | |
| "None", | |
| "ReadOnly", | |
| "AuditReadAccess", | |
| "AccessDataThroughOrchestrator" | |
| ], | |
| "type": "string", | |
| "readOnly": true, | |
| "x-ms-enum": { | |
| "name": "BucketCreatedEventOptions", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "None", | |
| "ReadOnly", | |
| "AuditReadAccess", | |
| "AccessDataThroughOrchestrator" | |
| ] | |
| }, | |
| "externalName": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "tags": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/TagDto" | |
| }, | |
| "readOnly": true | |
| }, | |
| "folderKeys": { | |
| "type": "array", | |
| "items": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| }, | |
| "eventTime": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "eventSource": {} | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "BucketDeletedEvent": { | |
| "type": "object", | |
| "properties": { | |
| "key": { | |
| "format": "uuid", | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "description": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "storageProvider": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "storageParameters": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "storageContainer": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "options": { | |
| "enum": [ | |
| "None", | |
| "ReadOnly", | |
| "AuditReadAccess", | |
| "AccessDataThroughOrchestrator" | |
| ], | |
| "type": "string", | |
| "readOnly": true, | |
| "x-ms-enum": { | |
| "name": "BucketDeletedEventOptions", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "None", | |
| "ReadOnly", | |
| "AuditReadAccess", | |
| "AccessDataThroughOrchestrator" | |
| ] | |
| }, | |
| "externalName": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "tags": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/TagDto" | |
| }, | |
| "readOnly": true | |
| }, | |
| "folderKeys": { | |
| "type": "array", | |
| "items": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| }, | |
| "eventTime": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "eventSource": {} | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "BucketDto": { | |
| "required": [ | |
| "Identifier", | |
| "Name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "Name": { | |
| "description": "Display name of the Bucket", | |
| "maxLength": 128, | |
| "minLength": 0, | |
| "type": "string" | |
| }, | |
| "Description": { | |
| "description": "Description of the Bucket", | |
| "maxLength": 512, | |
| "minLength": 0, | |
| "type": "string" | |
| }, | |
| "Identifier": { | |
| "format": "uuid", | |
| "description": "A stable unique identifier", | |
| "type": "string" | |
| }, | |
| "StorageProvider": { | |
| "description": "Provider Name.\r\nOtherwise one of the supported providers:\r\n- FileSystem\r\n- Azure\r\n- Amazon\r\n- Minio\r\n- S3Compatible\r\nLeave null for built-in Orchestrator host provider.", | |
| "type": "string" | |
| }, | |
| "StorageParameters": { | |
| "description": "Provider specific initialization parameters.\r\nUse a $Password for where the password should be inserted.\r\nLeave null for built-in Orchestrator host provider.", | |
| "type": "string" | |
| }, | |
| "StorageContainer": { | |
| "description": "Provider specific Container name (AWS, WASB).\r\nLeave null for built-in Orchestrator host provider.", | |
| "type": "string" | |
| }, | |
| "Options": { | |
| "description": "Bucket options", | |
| "enum": [ | |
| "None", | |
| "ReadOnly", | |
| "AuditReadAccess", | |
| "AccessDataThroughOrchestrator" | |
| ], | |
| "type": "string", | |
| "x-ms-enum": { | |
| "name": "BucketDtoOptions", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "None", | |
| "ReadOnly", | |
| "AuditReadAccess", | |
| "AccessDataThroughOrchestrator" | |
| ] | |
| }, | |
| "CredentialStoreId": { | |
| "format": "int64", | |
| "description": "Credential store used to keep the provider access password.\r\nLeave null for built-in Orchestrator host provider.", | |
| "type": "integer" | |
| }, | |
| "ExternalName": { | |
| "description": "The external name of the password in the credential store.\r\nIf null, it defaults to the bucket name.\r\nLeave null for built-in Orchestrator host provider.", | |
| "maxLength": 450, | |
| "minLength": 0, | |
| "type": "string" | |
| }, | |
| "Password": { | |
| "description": "Provider specific password/secret.\r\nIt is inserted as a replacement of the $Password token in the StorageParameters.\r\nLeave null for built-in Orchestrator host provider.", | |
| "type": "string" | |
| }, | |
| "FoldersCount": { | |
| "format": "int32", | |
| "description": "Number of folders where the bucket is shared.", | |
| "type": "integer" | |
| }, | |
| "Tags": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/TagDto" | |
| } | |
| }, | |
| "Id": { | |
| "format": "int64", | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "BucketFoldersShareDto": { | |
| "type": "object", | |
| "properties": { | |
| "BucketIds": { | |
| "type": "array", | |
| "items": { | |
| "format": "int64", | |
| "type": "integer" | |
| } | |
| }, | |
| "ToAddFolderIds": { | |
| "type": "array", | |
| "items": { | |
| "format": "int64", | |
| "type": "integer" | |
| } | |
| }, | |
| "ToRemoveFolderIds": { | |
| "type": "array", | |
| "items": { | |
| "format": "int64", | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "BucketUpdatedEvent": { | |
| "type": "object", | |
| "properties": { | |
| "key": { | |
| "format": "uuid", | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "description": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "storageProvider": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "storageParameters": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "storageContainer": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "options": { | |
| "enum": [ | |
| "None", | |
| "ReadOnly", | |
| "AuditReadAccess", | |
| "AccessDataThroughOrchestrator" | |
| ], | |
| "type": "string", | |
| "readOnly": true, | |
| "x-ms-enum": { | |
| "name": "BucketUpdatedEventOptions", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "None", | |
| "ReadOnly", | |
| "AuditReadAccess", | |
| "AccessDataThroughOrchestrator" | |
| ] | |
| }, | |
| "externalName": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "tags": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/TagDto" | |
| }, | |
| "readOnly": true | |
| }, | |
| "folderKeys": { | |
| "type": "array", | |
| "items": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| }, | |
| "eventTime": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "eventSource": {} | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "BuildTestSetRequestMessage": { | |
| "required": [ | |
| "releaseId", | |
| "versionNumber" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "releaseId": { | |
| "format": "int64", | |
| "type": "integer" | |
| }, | |
| "versionNumber": { | |
| "minLength": 1, | |
| "type": "string" | |
| }, | |
| "testCaseUniqueIds": { | |
| "type": "array", | |
| "items": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| }, | |
| "enableCoverage": { | |
| "type": "boolean" | |
| }, | |
| "maskBuildVersion": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "BulkAddQueueItemsRequest": { | |
| "required": [ | |
| "commitType", | |
| "queueName" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "queueName": { | |
| "minLength": 1, | |
| "type": "string" | |
| }, | |
| "commitType": { | |
| "enum": [ | |
| "AllOrNothing", | |
| "StopOnFirstFailure", | |
| "ProcessAllIndependently" | |
| ], | |
| "type": "string", | |
| "x-ms-enum": { | |
| "name": "BulkAddQueueItemsRequestCommitType", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "AllOrNothing", | |
| "StopOnFirstFailure", | |
| "ProcessAllIndependently" | |
| ] | |
| }, | |
| "queueItems": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/QueueItemDataDto" | |
| } | |
| } | |
| } | |
| }, | |
| "BulkItemDtoOfString": { | |
| "type": "object", | |
| "properties": { | |
| "Key": { | |
| "type": "string" | |
| }, | |
| "Status": { | |
| "enum": [ | |
| "Continue", | |
| "SwitchingProtocols", | |
| "Processing", | |
| "EarlyHints", | |
| "OK", | |
| "Created", | |
| "Accepted", | |
| "NonAuthoritativeInformation", | |
| "NoContent", | |
| "ResetContent", | |
| "PartialContent", | |
| "MultiStatus", | |
| "AlreadyReported", | |
| "IMUsed", | |
| "MultipleChoices", | |
| "Ambiguous", | |
| "MovedPermanently", | |
| "Moved", | |
| "Found", | |
| "Redirect", | |
| "SeeOther", | |
| "RedirectMethod", | |
| "NotModified", | |
| "UseProxy", | |
| "Unused", | |
| "TemporaryRedirect", | |
| "RedirectKeepVerb", | |
| "PermanentRedirect", | |
| "BadRequest", | |
| "Unauthorized", | |
| "PaymentRequired", | |
| "Forbidden", | |
| "NotFound", | |
| "MethodNotAllowed", | |
| "NotAcceptable", | |
| "ProxyAuthenticationRequired", | |
| "RequestTimeout", | |
| "Conflict", | |
| "Gone", | |
| "LengthRequired", | |
| "PreconditionFailed", | |
| "RequestEntityTooLarge", | |
| "RequestUriTooLong", | |
| "UnsupportedMediaType", | |
| "RequestedRangeNotSatisfiable", | |
| "ExpectationFailed", | |
| "MisdirectedRequest", | |
| "UnprocessableEntity", | |
| "UnprocessableContent", | |
| "Locked", | |
| "FailedDependency", | |
| "UpgradeRequired", | |
| "PreconditionRequired", | |
| "TooManyRequests", | |
| "RequestHeaderFieldsTooLarge", | |
| "UnavailableForLegalReasons", | |
| "InternalServerError", | |
| "NotImplemented", | |
| "BadGateway", | |
| "ServiceUnavailable", | |
| "GatewayTimeout", | |
| "HttpVersionNotSupported", | |
| "VariantAlsoNegotiates", | |
| "InsufficientStorage", | |
| "LoopDetected", | |
| "NotExtended", | |
| "NetworkAuthenticationRequired" | |
| ], | |
| "type": "string", | |
| "x-ms-enum": { | |
| "name": "BulkItemDto`1Status", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "Continue", | |
| "SwitchingProtocols", | |
| "Processing", | |
| "EarlyHints", | |
| "OK", | |
| "Created", | |
| "Accepted", | |
| "NonAuthoritativeInformation", | |
| "NoContent", | |
| "ResetContent", | |
| "PartialContent", | |
| "MultiStatus", | |
| "AlreadyReported", | |
| "IMUsed", | |
| "MultipleChoices", | |
| "Ambiguous", | |
| "MovedPermanently", | |
| "Moved", | |
| "Found", | |
| "Redirect", | |
| "SeeOther", | |
| "RedirectMethod", | |
| "NotModified", | |
| "UseProxy", | |
| "Unused", | |
| "TemporaryRedirect", | |
| "RedirectKeepVerb", | |
| "PermanentRedirect", | |
| "BadRequest", | |
| "Unauthorized", | |
| "PaymentRequired", | |
| "Forbidden", | |
| "NotFound", | |
| "MethodNotAllowed", | |
| "NotAcceptable", | |
| "ProxyAuthenticationRequired", | |
| "RequestTimeout", | |
| "Conflict", | |
| "Gone", | |
| "LengthRequired", | |
| "PreconditionFailed", | |
| "RequestEntityTooLarge", | |
| "RequestUriTooLong", | |
| "UnsupportedMediaType", | |
| "RequestedRangeNotSatisfiable", | |
| "ExpectationFailed", | |
| "MisdirectedRequest", | |
| "UnprocessableEntity", | |
| "UnprocessableContent", | |
| "Locked", | |
| "FailedDependency", | |
| "UpgradeRequired", | |
| "PreconditionRequired", | |
| "TooManyRequests", | |
| "RequestHeaderFieldsTooLarge", | |
| "UnavailableForLegalReasons", | |
| "InternalServerError", | |
| "NotImplemented", | |
| "BadGateway", | |
| "ServiceUnavailable", | |
| "GatewayTimeout", | |
| "HttpVersionNotSupported", | |
| "VariantAlsoNegotiates", | |
| "InsufficientStorage", | |
| "LoopDetected", | |
| "NotExtended", | |
| "NetworkAuthenticationRequired" | |
| ] | |
| }, | |
| "Body": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "BulkOperationErrorResponse": { | |
| "type": "object", | |
| "properties": { | |
| "taskId": { | |
| "format": "int64", | |
| "description": "Gets or sets the taskId for this task operation.", | |
| "type": "integer" | |
| }, | |
| "errorCode": { | |
| "format": "int32", | |
| "description": "Gets or sets the code of error occurred during this task's operation.", | |
| "type": "integer" | |
| }, | |
| "errorMessage": { | |
| "description": "Gets or sets the translated message of error occurred during this task's operation.", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "BulkOperationResponseDtoOfFailedQueueItemDto": { | |
| "type": "object", | |
| "properties": { | |
| "Success": { | |
| "type": "boolean" | |
| }, | |
| "Message": { | |
| "type": "string" | |
| }, | |
| "FailedItems": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/FailedQueueItemDto" | |
| } | |
| } | |
| } | |
| }, | |
| "BulkOperationResponseDtoOfGuid": { | |
| "type": "object", | |
| "properties": { | |
| "Success": { | |
| "type": "boolean" | |
| }, | |
| "Message": { | |
| "type": "string" | |
| }, | |
| "FailedItems": { | |
| "type": "array", | |
| "items": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "BulkOperationResponseDtoOfInt64": { | |
| "type": "object", | |
| "properties": { | |
| "Success": { | |
| "type": "boolean" | |
| }, | |
| "Message": { | |
| "type": "string" | |
| }, | |
| "FailedItems": { | |
| "type": "array", | |
| "items": { | |
| "format": "int64", | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "BulkTasksCompletionRequest": { | |
| "required": [ | |
| "action", | |
| "data", | |
| "taskIds" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "action": { | |
| "description": "Action taken on this task", | |
| "minLength": 1, | |
| "type": "string" | |
| }, | |
| "taskIds": { | |
| "description": "List of Task Ids which have to be Bulk edited", | |
| "type": "array", | |
| "items": { | |
| "format": "int64", | |
| "type": "integer" | |
| } | |
| }, | |
| "data": { | |
| "description": "Task data json" | |
| }, | |
| "title": { | |
| "description": "Title of tasks", | |
| "maxLength": 512, | |
| "type": "string" | |
| }, | |
| "taskCatalogId": { | |
| "format": "int64", | |
| "description": "Action Catalog to be associated with the tasks", | |
| "type": "integer" | |
| }, | |
| "unsetTaskCatalog": { | |
| "description": "Unset/Unassociate action catalogs with the tasks\r\nSet to true for unassociating catalog", | |
| "type": "boolean" | |
| }, | |
| "priority": { | |
| "description": "Priority of tasks", | |
| "enum": [ | |
| "Low", | |
| "Medium", | |
| "High", | |
| "Critical" | |
| ], | |
| "type": "string", | |
| "x-ms-enum": { | |
| "name": "BulkTasksDataUpdateRequestPriority", | |
| "modelAsString": false | |
| } | |
| }, | |
| "noteText": { | |
| "description": "Comment to be added while doing the bulk operation", | |
| "maxLength": 512, | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "BulkTasksDataUpdateRequest": { | |
| "required": [ | |
| "data", | |
| "taskIds" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "taskIds": { | |
| "description": "List of Task Ids which have to be Bulk edited", | |
| "type": "array", | |
| "items": { | |
| "format": "int64", | |
| "type": "integer" | |
| } | |
| }, | |
| "data": { | |
| "description": "Task data json" | |
| }, | |
| "title": { | |
| "description": "Title of tasks", | |
| "maxLength": 512, | |
| "type": "string" | |
| }, | |
| "taskCatalogId": { | |
| "format": "int64", | |
| "description": "Action Catalog to be associated with the tasks", | |
| "type": "integer" | |
| }, | |
| "unsetTaskCatalog": { | |
| "description": "Unset/Unassociate action catalogs with the tasks\r\nSet to true for unassociating catalog", | |
| "type": "boolean" | |
| }, | |
| "priority": { | |
| "description": "Priority of tasks", | |
| "enum": [ | |
| "Low", | |
| "Medium", | |
| "High", | |
| "Critical" | |
| ], | |
| "type": "string", | |
| "x-ms-enum": { | |
| "name": "BulkTasksDataUpdateRequestPriority", | |
| "modelAsString": false | |
| } | |
| }, | |
| "noteText": { | |
| "description": "Comment to be added while doing the bulk operation", | |
| "maxLength": 512, | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "BusinessRuleCreatedEvent": { | |
| "type": "object", | |
| "properties": { | |
| "key": { | |
| "format": "uuid", | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "description": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "tags": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/TagDto" | |
| }, | |
| "readOnly": true | |
| }, | |
| "folderKeys": { | |
| "type": "array", | |
| "items": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| }, | |
| "eventTime": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "eventSource": {} | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "BusinessRuleDeletedEvent": { | |
| "type": "object", | |
| "properties": { | |
| "key": { | |
| "format": "uuid", | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "description": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "tags": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/TagDto" | |
| }, | |
| "readOnly": true | |
| }, | |
| "folderKeys": { | |
| "type": "array", | |
| "items": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| }, | |
| "eventTime": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "eventSource": {} | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "BusinessRuleDto": { | |
| "required": [ | |
| "Name" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "Name": { | |
| "maxLength": 100, | |
| "type": "string" | |
| }, | |
| "Description": { | |
| "maxLength": 250, | |
| "type": "string" | |
| }, | |
| "CurrentVersion": { | |
| "$ref": "#/definitions/BusinessRuleVersionDto" | |
| }, | |
| "FoldersCount": { | |
| "format": "int32", | |
| "description": "Number of folders where the businessRule is shared.", | |
| "type": "integer" | |
| }, | |
| "Tags": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/TagDto" | |
| } | |
| }, | |
| "LastModificationTime": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "LastModifierUserId": { | |
| "format": "int64", | |
| "type": "integer" | |
| }, | |
| "CreationTime": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "CreatorUserId": { | |
| "format": "int64", | |
| "type": "integer" | |
| }, | |
| "Id": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "BusinessRuleFolderShareRequest": { | |
| "type": "object", | |
| "properties": { | |
| "BusinessRuleKeys": { | |
| "type": "array", | |
| "items": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| }, | |
| "ToAddFolderIds": { | |
| "type": "array", | |
| "items": { | |
| "format": "int64", | |
| "type": "integer" | |
| } | |
| }, | |
| "ToRemoveFolderIds": { | |
| "type": "array", | |
| "items": { | |
| "format": "int64", | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "BusinessRuleUpdatedEvent": { | |
| "type": "object", | |
| "properties": { | |
| "key": { | |
| "format": "uuid", | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "name": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "description": { | |
| "type": "string", | |
| "readOnly": true | |
| }, | |
| "tags": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/TagDto" | |
| }, | |
| "readOnly": true | |
| }, | |
| "folderKeys": { | |
| "type": "array", | |
| "items": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| }, | |
| "eventTime": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "eventSource": {} | |
| }, | |
| "additionalProperties": false | |
| }, | |
| "BusinessRuleVersionDownloadResponse": { | |
| "type": "object", | |
| "properties": { | |
| "VersionNumber": { | |
| "type": "string" | |
| }, | |
| "BusinessRuleName": { | |
| "type": "string" | |
| }, | |
| "DownloadUri": { | |
| "$ref": "#/definitions/BlobFileAccessDto" | |
| } | |
| } | |
| }, | |
| "BusinessRuleVersionDto": { | |
| "type": "object", | |
| "properties": { | |
| "BusinessRuleKey": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "VersionNumber": { | |
| "type": "string" | |
| }, | |
| "CreatorUserId": { | |
| "format": "int64", | |
| "type": "integer" | |
| }, | |
| "IsActive": { | |
| "type": "boolean" | |
| }, | |
| "CreationTime": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "Id": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "CalendarDto": { | |
| "type": "object", | |
| "properties": { | |
| "TimeZoneId": { | |
| "maxLength": 80, | |
| "type": "string" | |
| }, | |
| "ExcludedDates": { | |
| "type": "array", | |
| "items": { | |
| "format": "date-time", | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "CalendarExistsRequest": { | |
| "required": [ | |
| "calendarName" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "calendarName": { | |
| "minLength": 1, | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "CloudTemplateDto": { | |
| "description": "The cloud template that hosts the Robot", | |
| "type": "object", | |
| "allOf": [ | |
| { | |
| "$ref": "#/definitions/MachineDto" | |
| } | |
| ], | |
| "properties": { | |
| "externalPoolKey": { | |
| "format": "uuid", | |
| "description": "The external pool associated with the machine.", | |
| "type": "string" | |
| }, | |
| "hosting": { | |
| "description": "The Hosting type of the spec", | |
| "enum": [ | |
| "Customer", | |
| "System" | |
| ], | |
| "type": "string", | |
| "x-ms-enum": { | |
| "name": "CloudTemplateDtoHosting", | |
| "modelAsString": false | |
| } | |
| } | |
| } | |
| }, | |
| "ConfigurationEntry": { | |
| "type": "object", | |
| "properties": { | |
| "Key": { | |
| "type": "string" | |
| }, | |
| "DisplayName": { | |
| "type": "string" | |
| }, | |
| "ValueType": { | |
| "enum": [ | |
| "String", | |
| "Number", | |
| "Choice", | |
| "Boolean", | |
| "Section", | |
| "Secret", | |
| "SecretFile" | |
| ], | |
| "type": "string", | |
| "x-ms-enum": { | |
| "name": "ConfigurationEntryValueType", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "String", | |
| "Number", | |
| "Choice", | |
| "Boolean", | |
| "Section", | |
| "Secret", | |
| "SecretFile" | |
| ] | |
| } | |
| } | |
| }, | |
| "ConsumptionLicenseDto": { | |
| "type": "object", | |
| "properties": { | |
| "reference": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "count": { | |
| "format": "int64", | |
| "type": "integer" | |
| } | |
| } | |
| }, | |
| "ConsumptionLicenseStatsModel": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "used": { | |
| "format": "int64", | |
| "type": "integer" | |
| }, | |
| "total": { | |
| "format": "int64", | |
| "type": "integer" | |
| }, | |
| "timestamp": { | |
| "format": "date-time", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "CountStats": { | |
| "type": "object", | |
| "properties": { | |
| "title": { | |
| "type": "string" | |
| }, | |
| "count": { | |
| "format": "int64", | |
| "type": "integer" | |
| }, | |
| "hasPermissions": { | |
| "description": "Gives a more descriptive result when getting stats through the API (as opposed to -1 for the count)\r\nused only when serializing the count stats", | |
| "type": "boolean", | |
| "readOnly": true | |
| } | |
| } | |
| }, | |
| "CredentialSetDefaultStoreForResourceTypeRequest": { | |
| "required": [ | |
| "resourceType" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "resourceType": { | |
| "description": "This enum describes the type of resources that can be stored in the Credential Store. When\r\na new resource type is added, the default needs to be initialized in 3 places:\r\n1. Existing tenants: At migration time.\r\n2. Default tenant: At seed time in DefaultTenantCreator.cs.\r\n3. New tenants: In TenantService.cs.", | |
| "enum": [ | |
| "AssetCredential", | |
| "RobotCredential", | |
| "BucketCredential", | |
| "Secrets" | |
| ], | |
| "type": "string", | |
| "x-ms-enum": { | |
| "name": "CredentialSetDefaultStoreForResourceTypeRequestResourceType", | |
| "modelAsString": false | |
| }, | |
| "x-enum-varnames": [ | |
| "AssetCredential", | |
| "RobotCredential", | |
| "BucketCredential", | |
| "Secrets" | |
| ] | |
| } | |
| } | |
| }, | |
| "CredentialStoreDetailsDto": { | |
| "description": "Details about credential store", | |
| "type": "object", | |
| "properties": { | |
| "IsReadOnly": { | |
| "description": "Current store is read only", | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "CredentialStoreDto": { | |
| "description": "Defines the properties of a Credential Store.", | |
| "required": [ | |
| "Name", | |
| "Type" | |
| ], | |
| "type": "object", | |
| "properties": { | |
| "ProxyId": { | |
| "format": "int64", | |
| "type": "integer" | |
| }, | |
| "ProxyType": { | |
| "enum": [ | |
| "Connected", | |
| "Disconnected" | |
| ], | |
| "type": "string", | |
| "x-ms-enum": { | |
| "name": "CredentialStoreDtoProxyType", | |
| "modelAsString": false | |
| } | |
| }, | |
| "HostName": { | |
| "type": "string" | |
| }, | |
| "Name": { | |
| "minLength": 1, | |
| "type": "string" | |
| }, | |
| "Type": { |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment