Created
December 12, 2022 11:20
-
-
Save masatomix/9ca711a49490c87a5e04846f96493e15 to your computer and use it in GitHub Desktop.
Power Automateに処理させるように少しだけ修正した、UiPath Orchestrator APIのSwaggerの定義ファイル
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 15.0", | |
"description": "Orchestrator API", | |
"version": "15.0" | |
}, | |
"host": "cloud.uipath.com", | |
"basePath": "/mvpjapankino/enterpriseTenant/orchestrator_/", | |
"schemes": [ | |
"https" | |
], | |
"paths": { | |
"/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": "Success", | |
"schema": { | |
"$ref": "#/definitions/FolderDto" | |
} | |
} | |
}, | |
"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": "Success", | |
"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" | |
], | |
"produces": [ | |
"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": "Successful put", | |
"schema": { | |
"$ref": "#/definitions/ProcessScheduleDto" | |
} | |
}, | |
"200": { | |
"description": "Success", | |
"schema": { | |
"$ref": "#/definitions/ProcessScheduleDto" | |
} | |
} | |
}, | |
"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", | |
"produces": [ | |
"application/json" | |
], | |
"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": "Success" | |
} | |
}, | |
"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", | |
"produces": [ | |
"application/json" | |
], | |
"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" | |
} | |
} | |
}, | |
"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/Webhooks": { | |
"x-ms-notification-content": { | |
"schema": { | |
"type": "object", | |
"properties": { | |
"Type": { | |
"type": "string", | |
"description": "Type" | |
}, | |
"EventId": { | |
"type": "string", | |
"description": "EventId" | |
}, | |
"Timestamp": { | |
"type": "string", | |
"description": "Timestamp" | |
}, | |
"StartInfo": { | |
"type": "object", | |
"properties": { | |
"ReleaseKey": { | |
"type": "string", | |
"description": "ReleaseKey" | |
}, | |
"Strategy": { | |
"type": "string", | |
"description": "Strategy" | |
}, | |
"RobotIds": { | |
"type": "array", | |
"items": { | |
"type": "integer", | |
"format": "int32" | |
}, | |
"description": "RobotIds" | |
}, | |
"JobsCount": { | |
"type": "integer", | |
"format": "int32", | |
"description": "JobsCount" | |
}, | |
"Source": { | |
"type": "string", | |
"description": "Source" | |
} | |
}, | |
"description": "StartInfo" | |
}, | |
"Jobs": { | |
"type": "array", | |
"items": { | |
"type": "object", | |
"properties": { | |
"Id": { | |
"type": "integer", | |
"format": "int32", | |
"description": "Id" | |
}, | |
"Key": { | |
"type": "string", | |
"description": "Key" | |
}, | |
"State": { | |
"type": "string", | |
"description": "State" | |
}, | |
"Source": { | |
"type": "string", | |
"description": "Source" | |
}, | |
"SourceType": { | |
"type": "string", | |
"description": "SourceType" | |
}, | |
"BatchExecutionKey": { | |
"type": "string", | |
"description": "BatchExecutionKey" | |
}, | |
"ReleaseName": { | |
"type": "string", | |
"description": "ReleaseName" | |
}, | |
"Type": { | |
"type": "string", | |
"description": "Type" | |
}, | |
"HostMachineName": { | |
"type": "string", | |
"description": "HostMachineName" | |
}, | |
"Release": { | |
"type": "object", | |
"properties": { | |
"Id": { | |
"type": "integer", | |
"format": "int32", | |
"description": "Id" | |
}, | |
"Key": { | |
"type": "string", | |
"description": "Key" | |
}, | |
"ProcessKey": { | |
"type": "string", | |
"description": "ProcessKey" | |
}, | |
"ProcessVersion": { | |
"type": "string", | |
"description": "ProcessVersion" | |
}, | |
"Name": { | |
"type": "string", | |
"description": "Name" | |
}, | |
"Description": { | |
"type": "string", | |
"description": "Description" | |
}, | |
"IsLatestVersion": { | |
"type": "boolean", | |
"description": "IsLatestVersion" | |
}, | |
"InputArguments": { | |
"type": "string", | |
"description": "InputArguments" | |
} | |
}, | |
"description": "Release" | |
}, | |
"InputArguments": { | |
"type": "string", | |
"description": "InputArguments" | |
}, | |
"OutputArguments": { | |
"type": "string", | |
"description": "OutputArguments" | |
} | |
} | |
}, | |
"description": "Jobs" | |
}, | |
"TenantId": { | |
"type": "integer", | |
"format": "int32", | |
"description": "TenantId" | |
}, | |
"OrganizationUnitId": { | |
"type": "integer", | |
"format": "int32", | |
"description": "OrganizationUnitId" | |
}, | |
"UserId": { | |
"type": "integer", | |
"format": "int32", | |
"description": "UserId" | |
} | |
} | |
}, | |
"description": "hogehoge" | |
}, | |
"post": { | |
"tags": [ | |
"Webhooks" | |
], | |
"summary": "Orchestratorで指定したイベントが発生したら", | |
"description": "OAuth required scopes: OR.Webhooks or OR.Webhooks.Write.\n\nRequired permissions: Webhooks.Create.", | |
"operationId": "Webhooks_Post", | |
"x-ms-trigger": "single", | |
"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/WebhookDto1" | |
} | |
} | |
], | |
"responses": { | |
"201": { | |
"description": "Success", | |
"schema": { | |
"$ref": "#/definitions/WebhookDto1" | |
} | |
} | |
}, | |
"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", | |
"produces": [ | |
"application/json" | |
], | |
"parameters": [ | |
{ | |
"in": "path", | |
"name": "key", | |
"description": "", | |
"required": true, | |
"type": "integer", | |
"format": "int64" | |
} | |
], | |
"responses": { | |
"204": { | |
"description": "Success" | |
} | |
}, | |
"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": "Success", | |
"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": "Success", | |
"schema": { | |
"$ref": "#/definitions/CustomEventDto" | |
} | |
} | |
}, | |
"security": [ | |
{ | |
"OAuth2": [] | |
} | |
] | |
} | |
} | |
}, | |
"definitions": { | |
"ODataValueOfIEnumerableOfFolderDto": { | |
"type": "object", | |
"properties": { | |
"value": { | |
"type": "array", | |
"items": { | |
"$ref": "#/definitions/FolderDto" | |
} | |
} | |
} | |
}, | |
"FolderDto": { | |
"required": [ | |
"DisplayName" | |
], | |
"type": "object", | |
"properties": { | |
"Key": { | |
"format": "uuid", | |
"description": "Unique key for the folder", | |
"type": "string" | |
}, | |
"DisplayName": { | |
"description": "Display name for the folder.", | |
"maxLength": 115, | |
"type": "string" | |
}, | |
"FullyQualifiedName": { | |
"description": "Name of folder prepended by the names of its ancestors.", | |
"type": "string" | |
}, | |
"Description": { | |
"description": "Description of folder", | |
"maxLength": 500, | |
"type": "string" | |
}, | |
"IsPersonal": { | |
"description": "True if Personal", | |
"type": "boolean", | |
"readOnly": true | |
}, | |
"ProvisionType": { | |
"description": "Robot provisioning type", | |
"enum": [ | |
"Manual", | |
"Automatic" | |
], | |
"type": "string", | |
"x-ms-enum": { | |
"name": "FolderDtoProvisionType", | |
"modelAsString": false | |
} | |
}, | |
"PermissionModel": { | |
"description": "Folder permissions model", | |
"enum": [ | |
"InheritFromTenant", | |
"FineGrained" | |
], | |
"type": "string", | |
"x-ms-enum": { | |
"name": "FolderDtoPermissionModel", | |
"modelAsString": false | |
} | |
}, | |
"ParentId": { | |
"format": "int64", | |
"description": "Id of parent folder in the folders hierarchy", | |
"type": "integer" | |
}, | |
"ParentKey": { | |
"format": "uuid", | |
"description": "Unique key for the parent folder", | |
"type": "string" | |
}, | |
"FeedType": { | |
"description": "Folder feed type", | |
"enum": [ | |
"Undefined", | |
"Processes", | |
"Libraries", | |
"PersonalWorkspace", | |
"FolderHierarchy" | |
], | |
"type": "string", | |
"x-ms-enum": { | |
"name": "FolderDtoFeedType", | |
"modelAsString": false | |
} | |
}, | |
"Id": { | |
"format": "int64", | |
"type": "integer" | |
} | |
} | |
}, | |
"ODataValueOfIEnumerableOfProcessScheduleDto": { | |
"type": "object", | |
"properties": { | |
"value": { | |
"type": "array", | |
"items": { | |
"$ref": "#/definitions/ProcessScheduleDto" | |
} | |
} | |
} | |
}, | |
"ProcessScheduleDto": { | |
"description": "Defines the schedule of a process that can be executed at regular intervals, on selected Robots, all of them or a specified number of Robots.", | |
"required": [ | |
"Name", | |
"TimeZoneId" | |
], | |
"type": "object", | |
"properties": { | |
"Key": { | |
"format": "uuid", | |
"description": "The Key of the process schedule.", | |
"type": "string" | |
}, | |
"Enabled": { | |
"description": "Specifies if the schedule is active or not.", | |
"type": "boolean" | |
}, | |
"Name": { | |
"description": "The name of the schedule.", | |
"maxLength": 255, | |
"type": "string" | |
}, | |
"ReleaseId": { | |
"format": "int64", | |
"description": "The Id of the process associated with the schedule.", | |
"type": "integer" | |
}, | |
"ReleaseKey": { | |
"description": "The unique key of the process associated with the schedule.", | |
"type": "string" | |
}, | |
"ReleaseName": { | |
"description": "The name of the process associated with the schedule.", | |
"type": "string" | |
}, | |
"PackageName": { | |
"description": "The name of the package to be triggered with the schedule.", | |
"type": "string" | |
}, | |
"EnvironmentName": { | |
"description": "The name of the environment associated with the schedule.", | |
"type": "string" | |
}, | |
"EnvironmentId": { | |
"description": "The Id of the environment associated with the schedule.", | |
"type": "string" | |
}, | |
"JobPriority": { | |
"description": "The execution priority. If null, it will start jobs with the release's priority.", | |
"enum": [ | |
"Low", | |
"Normal", | |
"High" | |
], | |
"type": "string", | |
"x-ms-enum": { | |
"name": "ProcessScheduleDtoJobPriority", | |
"modelAsString": false | |
} | |
}, | |
"SpecificPriorityValue": { | |
"format": "int32", | |
"description": "Value for more granular control over execution priority.", | |
"maximum": 100, | |
"minimum": 1, | |
"type": "integer" | |
}, | |
"RuntimeType": { | |
"description": "The runtime type of the robot", | |
"enum": [ | |
"NonProduction", | |
"Attended", | |
"Unattended", | |
"Development", | |
"Studio", | |
"RpaDeveloper", | |
"CitizenDeveloper", | |
"StudioX", | |
"Headless", | |
"StudioPro", | |
"RpaDeveloperPro", | |
"TestAutomation", | |
"AutomationCloud", | |
"Serverless", | |
"AutomationKit" | |
], | |
"type": "string", | |
"x-ms-enum": { | |
"name": "ProcessScheduleDtoRuntimeType", | |
"modelAsString": false | |
} | |
}, | |
"StartProcessCron": { | |
"description": "The start cron expression of the schedule.", | |
"type": "string" | |
}, | |
"StartProcessCronDetails": { | |
"description": "Various details that can be associated to the time period expression of the schedule.", | |
"type": "string" | |
}, | |
"StartProcessCronSummary": { | |
"description": "Human readable form of cron expression of the schedule.", | |
"type": "string" | |
}, | |
"StartProcessNextOccurrence": { | |
"format": "date-time", | |
"description": "The date and time when the associated process will be run next.", | |
"type": "string" | |
}, | |
"StartStrategy": { | |
"format": "int32", | |
"description": "States which robots from the environment are being run by the schedule.", | |
"type": "integer" | |
}, | |
"ExecutorRobots": { | |
"description": "The collection of specific robots selected to be targeted by the current schedule. This collection must be empty if the start strategy is not 0 (specific robots).", | |
"type": "array", | |
"items": { | |
"$ref": "#/definitions/RobotExecutorDto" | |
} | |
}, | |
"StopProcessExpression": { | |
"description": "Number of seconds after which a running process will be stopped.", | |
"type": "string" | |
}, | |
"StopStrategy": { | |
"description": "The way a running process is stopped.", | |
"enum": [ | |
"SoftStop", | |
"Kill" | |
], | |
"type": "string", | |
"x-ms-enum": { | |
"name": "ProcessScheduleDtoStopStrategy", | |
"modelAsString": false | |
} | |
}, | |
"KillProcessExpression": { | |
"description": "Grace period (in seconds) for soft stop. If a process doesn't stop after this amount, it will be killed", | |
"type": "string" | |
}, | |
"ExternalJobKey": { | |
"description": "The unique identifier of the external job associated with the jobs generated by this schedule. A key is generated for each group of jobs triggered by this schedule.", | |
"type": "string" | |
}, | |
"ExternalJobKeyScheduler": { | |
"format": "uuid", | |
"description": "The unique identifier of the external background task schedule associated with the background tasks generated by this schedule. A key is generated for each batch of background tasks triggered by this schedule.", | |
"type": "string" | |
}, | |
"TimeZoneId": { | |
"description": "The timezone under which the schedule will run.", | |
"maxLength": 80, | |
"type": "string" | |
}, | |
"TimeZoneIana": { | |
"description": "The timezone under which the schedule will run in Iana Standard.", | |
"type": "string" | |
}, | |
"UseCalendar": { | |
"description": "DEPRECATED. Specify whether the schedule uses any calendar.", | |
"type": "boolean", | |
"x-deprecated": true | |
}, | |
"CalendarId": { | |
"format": "int64", | |
"description": "The id of the calendar that a process schedule uses.", | |
"type": "integer" | |
}, | |
"CalendarName": { | |
"description": "The name of the calendar.", | |
"type": "string" | |
}, | |
"StopProcessDate": { | |
"format": "date-time", | |
"type": "string" | |
}, | |
"InputArguments": { | |
"description": "Input parameters that will be passed to each job created by this schedule.", | |
"maxLength": 10000, | |
"type": "string" | |
}, | |
"QueueDefinitionId": { | |
"format": "int64", | |
"description": "The Id of the queue that uses this schedule for activation (trigger jobs when new queue items are added)", | |
"type": "integer" | |
}, | |
"QueueDefinitionName": { | |
"description": "The Name of the queue that uses this schedule for activation (trigger jobs when new queue items are added)", | |
"type": "string" | |
}, | |
"ItemsActivationThreshold": { | |
"format": "int64", | |
"description": "The minimum number of queue items that should trigger the process activation.", | |
"maximum": 10000, | |
"minimum": 1, | |
"type": "integer" | |
}, | |
"ItemsPerJobActivationTarget": { | |
"format": "int64", | |
"description": "The target ratio between the number of queue items and the Total number of jobs created by a process.", | |
"maximum": 10000, | |
"minimum": 1, | |
"type": "integer" | |
}, | |
"MaxJobsForActivation": { | |
"format": "int32", | |
"description": "The maximum number of jobs that a process can create as result of a Queue driven activation.", | |
"maximum": 10000, | |
"minimum": 1, | |
"type": "integer" | |
}, | |
"ResumeOnSameContext": { | |
"description": "Flag for honoring initial machine and robot choice upon resumption of created jobs, if jobs are suspended. <br />\r\nIf set, the jobs will resume on the same robot-machine pair on which they initially ran.", | |
"type": "boolean" | |
}, | |
"Description": { | |
"description": "Description of process schedule.", | |
"maxLength": 512, | |
"type": "string" | |
}, | |
"MachineRobots": { | |
"description": "The machine robots.", | |
"type": "array", | |
"items": { | |
"$ref": "#/definitions/MachineRobotSessionDto" | |
} | |
}, | |
"Tags": { | |
"type": "array", | |
"items": { | |
"$ref": "#/definitions/TagDto" | |
} | |
}, | |
"AlertPendingExpression": { | |
"type": "string" | |
}, | |
"AlertRunningExpression": { | |
"type": "string" | |
}, | |
"RunAsMe": { | |
"type": "boolean" | |
}, | |
"IsConnected": { | |
"description": "Whether this process trigger represents a connected trigger defined in package bindings", | |
"type": "boolean" | |
}, | |
"Id": { | |
"format": "int64", | |
"type": "integer" | |
} | |
} | |
}, | |
"ODataValueOfIEnumerableOfInt64": { | |
"type": "object", | |
"properties": { | |
"value": { | |
"type": "array", | |
"items": { | |
"format": "int64", | |
"type": "integer" | |
} | |
} | |
} | |
}, | |
"ProcessSetEnabledRequest": { | |
"type": "object", | |
"properties": { | |
"enabled": { | |
"type": "boolean" | |
}, | |
"scheduleIds": { | |
"type": "array", | |
"items": { | |
"format": "int64", | |
"type": "integer" | |
} | |
} | |
} | |
}, | |
"ODataValueOfBoolean": { | |
"type": "object", | |
"properties": { | |
"value": { | |
"type": "boolean" | |
} | |
} | |
}, | |
"ValidateProcessScheduleRequest": { | |
"required": [ | |
"processSchedule" | |
], | |
"type": "object", | |
"properties": { | |
"processSchedule": { | |
"$ref": "#/definitions/ProcessScheduleDto" | |
} | |
} | |
}, | |
"ValidationResultDto": { | |
"type": "object", | |
"properties": { | |
"IsValid": { | |
"type": "boolean" | |
}, | |
"Errors": { | |
"type": "array", | |
"items": { | |
"type": "string" | |
}, | |
"readOnly": true | |
} | |
} | |
}, | |
"WebhookDto": { | |
"required": [ | |
"AllowInsecureSsl", | |
"Enabled", | |
"SubscribeToAllEvents", | |
"Url" | |
], | |
"type": "object", | |
"properties": { | |
"Url": { | |
"format": "uri", | |
"maxLength": 2000, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"Enabled": { | |
"type": "boolean" | |
}, | |
"Secret": { | |
"maxLength": 100, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"SubscribeToAllEvents": { | |
"type": "boolean" | |
}, | |
"AllowInsecureSsl": { | |
"type": "boolean" | |
}, | |
"Events": { | |
"type": "array", | |
"items": { | |
"$ref": "#/definitions/WebhookEventDto" | |
} | |
}, | |
"Id": { | |
"format": "int64", | |
"type": "integer" | |
} | |
} | |
}, | |
"WebhookDto1": { | |
"required": [ | |
"AllowInsecureSsl", | |
"Enabled", | |
"SubscribeToAllEvents", | |
"Url" | |
], | |
"type": "object", | |
"properties": { | |
"Url": { | |
"format": "uri", | |
"maxLength": 2000, | |
"minLength": 0, | |
"type": "string", | |
"x-ms-notification-url": true, | |
"x-ms-visibility": "internal" | |
}, | |
"Enabled": { | |
"type": "boolean", | |
"default":true, | |
"x-ms-visibility": "internal" | |
}, | |
"Secret": { | |
"maxLength": 100, | |
"minLength": 0, | |
"type": "string", | |
"title": "シークレット" | |
}, | |
"SubscribeToAllEvents": { | |
"type": "boolean", | |
"default":true, | |
"title": "全てのイベント?" | |
}, | |
"AllowInsecureSsl": { | |
"type": "boolean", | |
"default":false, | |
"x-ms-visibility": "internal" | |
}, | |
"Events": { | |
"type": "array", | |
"items": { | |
"$ref": "#/definitions/WebhookEventDto1" | |
} | |
}, | |
"Id": { | |
"format": "int64", | |
"type": "integer", | |
"x-ms-visibility": "internal" | |
} | |
} | |
}, | |
"PingEventDto": { | |
"required": [ | |
"EventId", | |
"Timestamp", | |
"Type" | |
], | |
"type": "object", | |
"properties": { | |
"Type": { | |
"type": "string" | |
}, | |
"EventId": { | |
"maxLength": 50, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"EntityKey": { | |
"format": "uuid", | |
"type": "string" | |
}, | |
"Timestamp": { | |
"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" | |
}, | |
"UserId": { | |
"format": "int64", | |
"type": "integer" | |
} | |
}, | |
"x-webhook-event": "ping" | |
}, | |
"ODataValueOfIEnumerableOfWebhookEventTypeDto": { | |
"type": "object", | |
"properties": { | |
"value": { | |
"type": "array", | |
"items": { | |
"$ref": "#/definitions/WebhookEventTypeDto" | |
} | |
} | |
} | |
}, | |
"CustomEventDto": { | |
"description": "An event triggered by a robot Orchestrator activity", | |
"required": [ | |
"EventId", | |
"Timestamp", | |
"Type" | |
], | |
"type": "object", | |
"properties": { | |
"Type": { | |
"type": "string" | |
}, | |
"EventId": { | |
"maxLength": 50, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"EntityKey": { | |
"format": "uuid", | |
"type": "string" | |
}, | |
"Timestamp": { | |
"format": "date-time", | |
"type": "string" | |
}, | |
"EventData": { | |
"type": "object", | |
"additionalProperties": {} | |
}, | |
"EventSourceId": { | |
"format": "int64", | |
"type": "integer", | |
"readOnly": true | |
}, | |
"TenantId": { | |
"format": "int32", | |
"type": "integer" | |
}, | |
"OrganizationUnitId": { | |
"format": "int64", | |
"type": "integer" | |
}, | |
"OrganizationUnitKey": { | |
"format": "uuid", | |
"type": "string" | |
}, | |
"UserId": { | |
"format": "int64", | |
"type": "integer" | |
} | |
}, | |
"x-webhook-event": "CustomEventDto" | |
}, | |
"RobotExecutorDto": { | |
"description": "Stores information about a robot on which a process will be executed.", | |
"type": "object", | |
"properties": { | |
"MachineName": { | |
"description": "The name of the machine on which the robot runs the job.", | |
"type": "string" | |
}, | |
"Name": { | |
"description": "The name of the robot that runs the job.", | |
"type": "string" | |
}, | |
"Description": { | |
"description": "The description of the robot that runs the job.", | |
"type": "string" | |
}, | |
"Id": { | |
"format": "int64", | |
"type": "integer" | |
} | |
} | |
}, | |
"MachineRobotSessionDto": { | |
"type": "object", | |
"properties": { | |
"MachineId": { | |
"format": "int64", | |
"type": "integer" | |
}, | |
"MachineName": { | |
"type": "string" | |
}, | |
"RobotId": { | |
"format": "int64", | |
"type": "integer" | |
}, | |
"RobotUserName": { | |
"type": "string" | |
}, | |
"SessionId": { | |
"format": "int64", | |
"type": "integer" | |
}, | |
"SessionName": { | |
"type": "string" | |
} | |
} | |
}, | |
"TagDto": { | |
"required": [ | |
"Name" | |
], | |
"type": "object", | |
"properties": { | |
"Name": { | |
"maxLength": 256, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"DisplayName": { | |
"maxLength": 256, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"Value": { | |
"maxLength": 256, | |
"minLength": 0, | |
"type": "string" | |
}, | |
"DisplayValue": { | |
"maxLength": 256, | |
"minLength": 0, | |
"type": "string" | |
} | |
} | |
}, | |
"WebhookEventDto": { | |
"required": [ | |
"EventType" | |
], | |
"type": "object", | |
"properties": { | |
"EventType": { | |
"maxLength": 50, | |
"minLength": 0, | |
"type": "string" | |
} | |
} | |
}, | |
"WebhookEventDto1": { | |
"required": [ | |
"EventType" | |
], | |
"type": "object", | |
"properties": { | |
"EventType": { | |
"maxLength": 50, | |
"minLength": 0, | |
"type": "string", | |
"title": "個別のイベント" | |
} | |
} | |
}, | |
"WebhookEventTypeDto": { | |
"type": "object", | |
"properties": { | |
"Name": { | |
"description": "Event type key", | |
"type": "string" | |
}, | |
"Group": { | |
"description": "Group", | |
"type": "string" | |
} | |
} | |
} | |
}, | |
"securityDefinitions": { | |
"OAuth2": { | |
"type": "oauth2", | |
"flow": "accessCode", | |
"authorizationUrl": "https://cloud.uipath.com/identity_/connect/authorize", | |
"tokenUrl": "https://cloud.uipath.com/identity_/connect/token", | |
"scopes": { | |
"OR.Jobs": "OR.Jobs", | |
"OR.Machines": "OR.Machines", | |
"OR.Folders": "OR.Folders", | |
"OR.Webhooks": "OR.Webhooks", | |
"offline_access": "offline_access" | |
} | |
} | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment