UiPath Orchestrator
Запуск автоматизации в UiPath Cloud Orchestrator.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD) |
| Power Apps | Премия | Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Команда интеграции |
| URL | https://www.uipath.com/support |
| Адрес электронной почты | integrations-apps@uipath.com |
| Метаданные соединителя | |
|---|---|
| Publisher | UiPath |
| Website | https://www.uipath.com |
| Политика конфиденциальности | https://www.uipath.com/legal/privacy-policy |
| Категории | Искусственный интеллект; Бизнес-аналитика |
Соединитель Power Automate для UiPath Cloud Orchestrator позволяет использовать возможности автоматизации роботизированных процессов UiPaths в Power Automate. Это позволяет легко автоматизировать потоки между UiPath и Power Automate.
Предпосылки
Чтобы использовать этот соединитель, вам нужна учетная запись Cloud UiPath Automation Cloud . Если вы еще не являетесь клиентом UiPath, вы можете зарегистрироваться для пробной версии.
Убедитесь, что в клиенте развернуты службы автоматизации или настроены очереди.
Получение учетных данных
Если у вас нет имени пользователя и пароля для UiPath Automation Cloud, создайте собственную пробную учетную запись или обратитесь к администратору платформы UiPath.
Использование соединителя
Чтобы использовать соединитель, выполните следующие действия.
- Выберите UiPath Connector в качестве шага в потоке Power Automate.
- Введите идентификатор организации UiPath Cloud и идентификатор клиента в текстовых полях.
- Войдите на платформу UiPath с помощью учетных данных.
- После успешной проверки подлинности можно выбрать папки, процессы и очереди в форме.
- Теперь можно начать использовать соединитель в среде для создания приложений и потоков.
Ограничения
По состоянию на данный момент мы поддерживаем только облачные оркестраторы службы автоматизации.
Классические папки Orchestrator не поддерживаются. Обязательно используйте только современные папки.
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Название организации | струна | Укажите имя организации. | True |
| Имя клиента. | струна | Укажите имя клиента. | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Добавление элемента очереди |
Добавьте новый элемент очереди для обработки. |
| Начать задание |
Создает новое задание и задает его в состоянии ожидания для каждого робота на основе входных параметров и уведомляет соответствующих роботов о ожидании задания. |
Добавление элемента очереди
Добавьте новый элемент очереди для обработки.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя
|
Name | string |
Обязательное. Имя очереди, в которую будет добавлен элемент. |
|
|
Priority
|
Priority | string |
Задает важность обработки для данного элемента. |
|
|
Определенное содержимое
|
SpecificContent | object |
Коллекция пар значений ключей. Пример: "Name":"John", "Status": true |
|
|
Дата отсрочки
|
DeferDate | date-time |
Самая ранняя дата и время, в течение которого элемент доступен для обработки. Если пустой элемент может быть обработан как можно скорее. |
|
|
Срок
|
DueDate | date-time |
Последняя дата и время обработки элемента. Если пустой элемент может обрабатываться в любое время. |
|
|
Дата обслуживания о рисках
|
RiskSlaDate | date-time |
Дата RiskSla во время обработки элемента, которая считается зоной риска. |
|
|
Reference
|
Reference | string |
Необязательное, указанное пользователем значение для идентификации элемента очереди. |
|
|
Progress
|
Progress | string |
Строковое поле, которое используется для отслеживания хода выполнения бизнес-потока. |
|
|
Folder
|
X-UIPATH-OrganizationUnitId | True | integer |
Идентификатор folder/OrganizationUnit |
Возвращаемое значение
Определяет часть данных, которые могут обрабатываться роботом и информацией, связанной с его состоянием обработки. Элементы очереди группируются в очередях.
- Тело
- QueueItemDto
Начать задание
Создает новое задание и задает его в состоянии ожидания для каждого робота на основе входных параметров и уведомляет соответствующих роботов о ожидании задания.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя процесса
|
ReleaseKey | True | string |
Обязательное. Выберите процесс, который требуется запустить. |
|
JobsCount
|
JobsCount | True | integer |
Обязательное. Количество ожидающих заданий в среде для текущего процесса. Это число должно быть больше 0, только если начальная стратегия — JobsCount. |
|
Исходный материал
|
Source | string |
Источник задания, запускающего текущий процесс. |
|
|
JobPriority
|
JobPriority | string |
Приоритет выполнения. Если значение NULL, по умолчанию используется значение JobPriority его выпуска. |
|
|
RuntimeType
|
RuntimeType | string | ||
|
InputArguments
|
InputArguments | string |
Входные параметры в формате JSON, передаваемые в выполнение задания. |
|
|
Reference
|
Reference | string |
Необязательная ссылка, указанная пользователем для заданий |
|
|
Folder
|
X-UIPATH-OrganizationUnitId | True | integer |
Идентификатор folder/OrganizationUnit |
Возвращаемое значение
Определения
ArgumentMetadata
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Ввод
|
Input | string | |
|
Выходные данные
|
Output | string |
AttendedRobotDto
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Имя пользователя
|
UserName | string |
Имя пользователя, используемое для проверки подлинности на хост-компьютере. |
|
ExecutionSettings
|
ExecutionSettings | object |
Объект, содержащий параметры выполнения для робота. |
|
RobotId
|
RobotId | integer |
Фактический идентификатор подготовленного робота. |
|
RobotType
|
RobotType | string |
Фактический тип подготовленного робота. |
EntryPointDataVariationDto
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Content
|
Content | string | |
|
ContentType
|
ContentType | string | |
|
Идентификатор
|
Id | integer |
EntryPointDto
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
UniqueId
|
UniqueId | uuid | |
|
Путь
|
Path | string | |
|
InputArguments
|
InputArguments | string | |
|
OutputArguments
|
OutputArguments | string | |
|
DataVariation
|
DataVariation | EntryPointDataVariationDto | |
|
Идентификатор
|
Id | integer |
EnvironmentDto
Группировка роботов.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Имя
|
Name | string |
Настраиваемое имя среды. |
|
Description
|
Description | string |
Используется для добавления дополнительных сведений о среде, чтобы лучше определить ее. |
|
Роботов
|
Robots | array of SimpleRobotDto |
Коллекция роботов, связанных с текущей средой. |
|
Тип
|
Type | string |
УСТАРЕВШИЕ. Тип среды указывает, как его следует использовать. Это свойство устарело и больше не должно использоваться. |
|
Идентификатор
|
Id | integer |
JobDto
Представляет запланированное или ручное выполнение процесса на роботе.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Key
|
Key | uuid |
Уникальный идентификатор задания. |
|
StartTime
|
StartTime | date-time |
Дата и время начала выполнения задания или значение NULL, если задание еще не запущено. |
|
EndTime
|
EndTime | date-time |
Дата и время окончания выполнения задания или значение NULL, если задание еще не завершено. |
|
Государство
|
State | string |
Состояние, в котором находится задание. |
|
JobPriority
|
JobPriority | string |
Приоритет выполнения. |
|
Robot
|
Robot | SimpleRobotDto |
Сущность, производная от RobotDto. Предоставляет общий доступ ко всем свойствам базовой сущности, кроме свойств навигации. |
|
Релиз
|
Release | SimpleReleaseDto |
Сущность, производная от BaseReleaseDto. Он использует все свойства базовой сущности, кроме свойств навигации. |
|
Исходный материал
|
Source | string |
Имя источника задания. |
|
Тип источника
|
SourceType | string |
Исходный тип задания. |
|
BatchExecutionKey
|
BatchExecutionKey | uuid |
Уникальный идентификатор, группирование нескольких заданий. Обычно он создается при создании задания по расписанию. |
|
Info
|
Info | string |
Дополнительные сведения о текущем задании. |
|
CreationTime
|
CreationTime | date-time |
Дата и время создания задания. |
|
StartingScheduleId
|
StartingScheduleId | integer |
Идентификатор расписания, запускающего задание, или значение NULL, если задание было запущено пользователем. |
|
ReleaseName
|
ReleaseName | string |
Имя выпуска, связанного с текущим именем. |
|
Тип
|
Type | string |
Тип задания, участие, если началось с помощью робота, автоматическое выполнение в противном случае |
|
InputArguments
|
InputArguments | string |
Входные параметры в формате JSON, передаваемые в выполнение задания |
|
OutputArguments
|
OutputArguments | string |
Выходные параметры в формате JSON привели к выполнению задания |
|
HostMachineName
|
HostMachineName | string |
Имя компьютера, на котором робот запускает задание. |
|
HasMediaRecorded
|
HasMediaRecorded | boolean |
Значение True, если для этого задания записан любой носитель выполнения, значение false в противном случае. |
|
PersistenceId
|
PersistenceId | uuid |
Идентификатор экземпляра сохраняемости для приостановленного задания |
|
ResumeVersion
|
ResumeVersion | integer |
Различие между несколькими циклами приостановки и возобновления задания |
|
StopStrategy
|
StopStrategy | string | |
|
RuntimeType
|
RuntimeType | string |
Тип среды выполнения робота, который может забрать задание |
|
ТребуетСяUserInteraction
|
RequiresUserInteraction | boolean | |
|
ReleaseVersionId
|
ReleaseVersionId | integer | |
|
EntryPointPath
|
EntryPointPath | string |
Путь к рабочему процессу точки входа (XAML), который будет выполняться роботом |
|
OrganizationUnitId
|
OrganizationUnitId | integer |
Идентификатор папки, в рамках этого задания. |
|
OrganizationUnitFullyQualifiedName
|
OrganizationUnitFullyQualifiedName | string |
Полное имя папки, в рамках этого задания. |
|
Reference
|
Reference | string |
Идентификатор ссылки для задания |
|
ProcessType
|
ProcessType | string | |
|
Компьютер
|
Machine | MachineDto |
Компьютер, на котором размещен робот |
|
ПрофилированиеOptions
|
ProfilingOptions | string |
Параметры для указания роботу, какие данные профилирования собираются (покрытие кода, загрузка ЦП или памяти и т. д.) |
|
Идентификатор
|
Id | integer |
MachineDto
Компьютер, на котором размещен робот
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
LicenseKey
|
LicenseKey | string |
Ключ автоматически создается на сервере для компьютера Робота. Чтобы робот работал, тот же ключ должен существовать как на роботе, так и на оркестраторе. |
|
Имя
|
Name | string |
Имя компьютера, на котором размещен робот. |
|
Description
|
Description | string | |
|
Тип
|
Type | string |
Тип компьютера (стандартный или шаблон). |
|
Scope
|
Scope | string |
Область компьютера (по умолчанию / общий / PW / облако). |
|
NonProductionSlots
|
NonProductionSlots | integer |
Количество слотов NonProduction, зарезервированных во время выполнения |
|
UnattendedSlots
|
UnattendedSlots | integer |
Количество автоматических слотов, зарезервированных во время выполнения |
|
Головные Слоды
|
HeadlessSlots | integer |
Количество слотов без головы, зарезервированных во время выполнения |
|
TestAutomationSlots
|
TestAutomationSlots | integer |
Количество слотов TestAutomation, зарезервированных во время выполнения |
|
Key
|
Key | uuid |
Неизменяемый уникальный идентификатор, сохраненный во время миграции клиента |
|
RobotVersions
|
RobotVersions | array of MachinesRobotVersionDto |
Версии роботов, размещенных на компьютере. |
|
РоботУсы
|
RobotUsers | array of RobotUserDto |
Роботы, назначенные компьютеру-шаблону. |
|
AutoScalingProfile
|
AutoScalingProfile | string |
Профиль, который управляет автоматическим масштабированием. |
|
Идентификатор
|
Id | integer |
MachinesRobotVersionDto
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Численность
|
Count | integer |
Число роботов на компьютере с указанной версией. |
|
Версия
|
Version | string |
Версия робота, размещенного на компьютере. |
|
MachineId
|
MachineId | integer |
Идентификатор компьютера. |
ODataValueOfIEnumerableOfJobDto
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
value
|
value | array of JobDto |
OrganizationUnitDto
Хранит сведения об подразделении организации в Orchestrator. Подразделение оркестратора можно понять как отдел компании, и он используется для группировки различных сущностей.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Отображаемое имя
|
DisplayName | string |
Имя подразделения организации. |
|
Идентификатор
|
Id | integer |
ProcessingExceptionDto
Сохраняет сведения об исключениях, создаваемых при обработке элементов очереди сбоем.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Причина
|
Reason | string |
Причина сбоя обработки. |
|
Сведения
|
Details | string |
Сохраняет дополнительные сведения об исключении. |
|
Тип
|
Type | string |
Тип исключения обработки, если таковой есть. |
|
AssociatedImageFilePath
|
AssociatedImageFilePath | string |
Путь на роботе под управлением компьютера к файлу изображения, в котором хранятся соответствующие сведения об исключении, например системный экран печати. |
|
CreationTime
|
CreationTime | date-time |
Время возникновения исключения |
ProcessSettingsDto
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
ErrorRecordingEnabled
|
ErrorRecordingEnabled | boolean | |
|
Продолжительность
|
Duration | integer | |
|
Частота
|
Frequency | integer | |
|
Качество
|
Quality | integer | |
|
AutoStartProcess
|
AutoStartProcess | boolean | |
|
AlwaysRunning
|
AlwaysRunning | boolean |
QueueDefinitionDto
Определение рабочей очереди. Очередь работы содержит рабочие элементы, обрабатываемые роботами.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Имя
|
Name | string |
Настраиваемое имя очереди. |
|
Description
|
Description | string |
Используется для добавления дополнительных сведений о очереди, чтобы лучше определить ее. |
|
MaxNumberOfRetries
|
MaxNumberOfRetries | integer |
Целочисленное значение, представляющее количество раз, когда элемент этой очереди можно извлечь, если обработка завершается сбоем при исключении приложения и автоматическое повторение. |
|
AcceptAutomaticallyRetry
|
AcceptAutomaticallyRetry | boolean |
Указывает, должен ли робот повторить обработку элемента, если после обработки он завершился ошибкой с исключением приложения. |
|
Принудительное применениеUniqueReference
|
EnforceUniqueReference | boolean |
Указывает, должно ли быть уникальное поле "Ссылка на элементы" для каждой очереди. Удаленные и повторные элементы не проверяются в этом правиле. |
|
SpecificDataJsonSchema
|
SpecificDataJsonSchema | string |
Схема JSON, примененная к конкретному полю данных. |
|
OutputDataJsonSchema
|
OutputDataJsonSchema | string |
Схема JSON, примененная к полю выходных данных. |
|
AnalyticsDataJsonSchema
|
AnalyticsDataJsonSchema | string |
Схема JSON, примененная к полю данных аналитики. |
|
CreationTime
|
CreationTime | date-time |
Дата и время создания очереди. |
|
ProcessScheduleId
|
ProcessScheduleId | integer |
Идентификатор расписания процесса, связанного с очередью. |
|
SlaInMinutes
|
SlaInMinutes | integer |
Элемент очереди обрабатывает соглашение об уровне обслуживания на уровне QueueDefinition. |
|
RiskSlaInMinutes
|
RiskSlaInMinutes | integer |
Соглашение об уровне обслуживания об уровне обслуживания элемента очереди на уровне QueueDefinition. |
|
ReleaseId
|
ReleaseId | integer |
Очередь ProcessId связана с. |
|
IsProcessInCurrentFolder
|
IsProcessInCurrentFolder | boolean |
Пометка, чтобы определить, находится ли выпуск в текущей папке |
|
ПапкаCount
|
FoldersCount | integer |
Количество папок, в которых предоставляется общий доступ к очереди. |
|
OrganizationUnitId
|
OrganizationUnitId | integer |
УСТАРЕВШИЕ. |
|
OrganizationUnitFullyQualifiedName
|
OrganizationUnitFullyQualifiedName | string |
УСТАРЕВШИЕ. |
|
Идентификатор
|
Id | integer |
QueueItemDto
Определяет часть данных, которые могут обрабатываться роботом и информацией, связанной с его состоянием обработки. Элементы очереди группируются в очередях.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
QueueDefinitionId
|
QueueDefinitionId | integer |
Идентификатор родительской очереди. |
|
QueueDefinition
|
QueueDefinition | QueueDefinitionDto |
Определение рабочей очереди. Очередь работы содержит рабочие элементы, обрабатываемые роботами. |
|
ProcessingException
|
ProcessingException | ProcessingExceptionDto |
Сохраняет сведения об исключениях, создаваемых при обработке элементов очереди сбоем. |
|
SpecificContent
|
SpecificContent | object |
Коллекция пар значений ключей, содержащих пользовательские данные, настроенные в действии "Добавление элемента очереди" в UiPath Studio. |
|
Выходные данные
|
Output | object |
Коллекция пар значений ключей, содержащих пользовательские данные, которые привели к успешной обработке. |
|
OutputData
|
OutputData | string |
Представление JSON выходных данных, созданных обработкой элемента. |
|
Аналитика
|
Analytics | object |
Коллекция пар значений ключей, содержащих пользовательские данные для дальнейшей обработки аналитики. |
|
AnalyticsData
|
AnalyticsData | string |
Представление JSON-данных аналитики, созданных обработкой элемента. |
|
Состояние
|
Status | string |
Состояние обработки элемента. |
|
ReviewStatus
|
ReviewStatus | string |
Состояние проверки элемента — применимо только для неудачных элементов. |
|
РецензентUserId
|
ReviewerUserId | integer |
Идентификатор пользователя рецензента, если таковой есть. |
|
РецензентUser
|
ReviewerUser | SimpleUserDto |
Сущность, производная от UserDto. Предоставляет общий доступ ко всем свойствам базовой сущности, кроме свойств навигации. |
|
Key
|
Key | uuid |
Уникальный идентификатор элемента очереди. |
|
Reference
|
Reference | string |
Необязательное, указанное пользователем значение для идентификации элемента очереди. |
|
ProcessingExceptionType
|
ProcessingExceptionType | string |
Исключение обработки. Если элемент не был обработан или успешно обработан, он будет иметь значение NULL. |
|
Дата выполнения
|
DueDate | date-time |
Последняя дата и время обработки элемента. Если пустой элемент может обрабатываться в любое время. |
|
RiskSlaDate
|
RiskSlaDate | date-time |
Дата RiskSla во время обработки элемента, которая считается зоной риска. |
|
Priority
|
Priority | string |
Задает важность обработки для данного элемента. |
|
Robot
|
Robot | SimpleRobotDto |
Сущность, производная от RobotDto. Предоставляет общий доступ ко всем свойствам базовой сущности, кроме свойств навигации. |
|
DeferDate
|
DeferDate | date-time |
Самая ранняя дата и время, в течение которого элемент доступен для обработки. Если пустой элемент может быть обработан как можно скорее. |
|
StartProcessing
|
StartProcessing | date-time |
Дата и время начала обработки элемента. Это значение null, если элемент не был обработан. |
|
EndProcessing
|
EndProcessing | date-time |
Дата и время окончания обработки элемента. Это значение null, если элемент не был обработан. |
|
SecondsInPreviousAttempts
|
SecondsInPreviousAttempts | integer |
Количество секунд, которые длилась последняя неудачная обработка. |
|
Предки
|
AncestorId | integer |
Идентификатор элемента-предка, подключенного к текущему элементу. |
|
Повторная попытка
|
RetryNumber | integer |
Количество раз обработки этого рабочего элемента. Это может быть выше 0, только если задано число MaxRetried, а обработка элементов завершилась сбоем по крайней мере один раз с ApplicationException. |
|
SpecificData
|
SpecificData | string |
Представление JSON конкретного содержимого. |
|
CreationTime
|
CreationTime | date-time |
Дата и время создания элемента. |
|
Progress
|
Progress | string |
Строковое поле, которое используется для отслеживания хода выполнения бизнес-потока. |
|
RowVersion
|
RowVersion | byte |
Идентификатор, используемый для оптимистического параллелизма, поэтому Orchestrator может определить, устарели ли данные. |
|
OrganizationUnitId
|
OrganizationUnitId | integer |
УСТАРЕВШИЕ. |
|
OrganizationUnitFullyQualifiedName
|
OrganizationUnitFullyQualifiedName | string |
УСТАРЕВШИЕ. |
|
Идентификатор
|
Id | integer |
ReleaseVersionDto
Хранит данные о версии различных версий процесса, связанного с определенным выпуском. Если определенная версия связана и отключена с выпуском нового объекта ReleaseVersion, создается для каждой ассоциации.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
ReleaseId
|
ReleaseId | integer |
Идентификатор родительского выпуска. |
|
VersionNumber
|
VersionNumber | string |
Версия процесса, связанного с выпуском. |
|
CreationTime
|
CreationTime | date-time |
Дата и время, когда версия была связана с выпуском. |
|
ReleaseName
|
ReleaseName | string |
Имя процесса, связанного с выпуском. |
|
Идентификатор
|
Id | integer |
РоботUserDto
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Имя пользователя
|
UserName | string |
Имя пользователя. |
|
RobotId
|
RobotId | integer |
Идентификатор робота. |
|
HasTriggers
|
HasTriggers | boolean |
Определяет ли робот машины триггеры или нет. |
SimpleReleaseDto
Сущность, производная от BaseReleaseDto. Он использует все свойства базовой сущности, кроме свойств навигации.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Key
|
Key | string |
Уникальный идентификатор, связанный с каждым выпуском. |
|
ProcessKey
|
ProcessKey | string |
Уникальный идентификатор процесса, связанного с выпуском. |
|
ProcessVersion
|
ProcessVersion | string |
Версия процесса, связанного с выпуском. |
|
IsLatestVersion
|
IsLatestVersion | boolean |
Указывает, является ли версия процесса, связанного с выпуском, последней или нет. |
|
IsProcessDeleted
|
IsProcessDeleted | boolean |
Указывает, удаляется ли процесс, связанный с выпуском. |
|
Description
|
Description | string |
Используется для добавления дополнительных сведений о выпуске, чтобы лучше определить его. |
|
Имя
|
Name | string |
Настраиваемое имя выпуска. Формат имени по умолчанию — ProcessName_EnvironmentName. |
|
EnvironmentId
|
EnvironmentId | integer |
Идентификатор среды, связанной с выпуском. |
|
Имя среды
|
EnvironmentName | string |
Имя среды, связанной с выпуском. |
|
Окружающая среда
|
Environment | EnvironmentDto |
Группировка роботов. |
|
EntryPointId
|
EntryPointId | integer | |
|
EntryPoint
|
EntryPoint | EntryPointDto | |
|
InputArguments
|
InputArguments | string |
Входные параметры в формате JSON, передаваемые в качестве значений по умолчанию для выполнения задания. |
|
ProcessType
|
ProcessType | string | |
|
ПоддержкаMultipleEntryPoints
|
SupportsMultipleEntryPoints | boolean | |
|
ТребуетСяUserInteraction
|
RequiresUserInteraction | boolean | |
|
CurrentVersion
|
CurrentVersion | ReleaseVersionDto |
Хранит данные о версии различных версий процесса, связанного с определенным выпуском. Если определенная версия связана и отключена с выпуском нового объекта ReleaseVersion, создается для каждой ассоциации. |
|
ReleaseVersions
|
ReleaseVersions | array of ReleaseVersionDto |
Коллекция версий выпуска, которые текущий выпуск имел с течением времени. |
|
Arguments
|
Arguments | ArgumentMetadata | |
|
ProcessSettings
|
ProcessSettings | ProcessSettingsDto | |
|
Автоматическое обновление
|
AutoUpdate | boolean | |
|
FeedId
|
FeedId | uuid | |
|
JobPriority
|
JobPriority | string |
Приоритет выполнения. Если значение NULL, оно по умолчанию имеет значение "Обычный". |
|
CreationTime
|
CreationTime | date-time |
Время создания этого выпуска. |
|
OrganizationUnitId
|
OrganizationUnitId | integer |
Идентификатор папки этого выпуска является частью. |
|
OrganizationUnitFullyQualifiedName
|
OrganizationUnitFullyQualifiedName | string |
Полное имя папки, в рамках этой версии. |
|
Идентификатор
|
Id | integer |
SimpleRobotDto
Сущность, производная от RobotDto. Предоставляет общий доступ ко всем свойствам базовой сущности, кроме свойств навигации.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
LicenseKey
|
LicenseKey | string |
Ключ автоматически создается на сервере для компьютера Робота. Чтобы робот работал, тот же ключ должен существовать как на роботе, так и на оркестраторе. |
|
MachineName
|
MachineName | string |
Имя компьютера, на котором размещен робот. |
|
MachineId
|
MachineId | integer |
Идентификатор машины, на котором размещен робот |
|
Имя
|
Name | string |
Настраиваемое имя робота. |
|
Имя пользователя
|
Username | string |
Имя пользователя компьютера. Если пользователь находится под доменом, необходимо также указать его в формате DOMAIN\username. Примечание. Необходимо использовать короткие доменные имена, такие как desktop\administrator и NOT desktop.local/administrator. |
|
ExternalName
|
ExternalName | string |
Содержит значение ключа во внешнем хранилище, используемом для хранения пароля. |
|
Description
|
Description | string |
Используется для добавления дополнительных сведений о роботе, чтобы лучше определить его. |
|
Тип
|
Type | string |
Тип робота. |
|
HostingType
|
HostingType | string |
Тип размещения робота (стандартный или плавающий). |
|
ProvisionType
|
ProvisionType | string |
Тип подготовки робота. |
|
Пароль
|
Password | string |
Пароль Windows, связанный с именем пользователя компьютера. |
|
CredentialStoreId
|
CredentialStoreId | integer |
Хранилище учетных данных, используемое для хранения пароля. |
|
UserId
|
UserId | integer |
Идентификатор связанного пользователя. |
|
Включен
|
Enabled | boolean |
Особенности состояния робота (включено или отключено) — отключенный робот не может подключиться к Orchestrator |
|
CredentialType
|
CredentialType | string |
Тип учетных данных робота (default/ SmartCard) |
|
Окружающая среда
|
Environments | array of EnvironmentDto |
Коллекция сред робот является частью. |
|
РоботEnvironments
|
RobotEnvironments | string |
Разделенное запятыми текстовое представление имен среды робот является частью. |
|
ExecutionSettings
|
ExecutionSettings | object |
Коллекция пар значений ключей, содержащих параметры выполнения для этого робота. |
|
IsExternalLicensed
|
IsExternalLicensed | boolean |
Флаг, указывающий, использует ли робот внешнюю лицензию |
|
LimitConcurrentExecution
|
LimitConcurrentExecution | boolean |
Указывает, может ли робот использоваться одновременно на нескольких компьютерах |
|
Идентификатор
|
Id | integer |
SimpleUserDto
Сущность, производная от UserDto. Предоставляет общий доступ ко всем свойствам базовой сущности, кроме свойств навигации.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Имя
|
Name | string |
Имя пользователя, для которого создается пользователь. |
|
Surname
|
Surname | string |
Фамилия пользователя, для которого создается пользователь. |
|
Имя пользователя
|
UserName | string |
Имя, используемое для входа в Orchestrator. |
|
Домен
|
Domain | string |
Домен, из которого импортируется пользователь |
|
DirectoryIdentifier
|
DirectoryIdentifier | string |
Идентификатор каталога, из которого импортируется пользователь |
|
FullName
|
FullName | string |
Полное имя человека, созданного с помощью фамилии имени формата. |
|
Электронный адрес
|
EmailAddress |
Адрес электронной почты, связанный с пользователем. |
|
|
IsEmailConfirmed
|
IsEmailConfirmed | boolean |
Указывает, является ли адрес электронной почты допустимым или нет. |
|
LastLoginTime
|
LastLoginTime | date-time |
Дата и время последнего входа пользователя или значение NULL, если пользователь никогда не вошел в систему. |
|
Активен
|
IsActive | boolean |
Указывает, является ли пользователь активным или нет. Неактивный пользователь не может войти в Orchestrator. |
|
CreationTime
|
CreationTime | date-time |
Дата и время создания пользователя. |
|
AuthenticationSource
|
AuthenticationSource | string |
Источник, прошедший проверку подлинности этого пользователя. |
|
Пароль
|
Password | string |
Пароль, используемый во время входа в приложение. |
|
IsExternalLicensed
|
IsExternalLicensed | boolean | |
|
UserRoles
|
UserRoles | array of UserRoleDto |
Коллекция ролей, связанных с пользователем. |
|
RoleList
|
RolesList | array of string |
Коллекция имен ролей, связанных с пользователем. |
|
LoginProviders
|
LoginProviders | array of string |
Коллекция сущностей, которые могут пройти проверку подлинности пользователя. |
|
OrganizationUnits
|
OrganizationUnits | array of OrganizationUnitDto |
Коллекция подразделений, связанных с пользователем. |
|
Идентификатор арендатора (TenantId)
|
TenantId | integer |
Идентификатор клиента, принадлежащий пользователю. |
|
Имя клиента
|
TenancyName | string |
Имя клиента, хладеющего пользователем. |
|
TenantDisplayName
|
TenantDisplayName | string |
Отображаемое имя клиента, владеющего пользователем. |
|
TenantKey
|
TenantKey | string |
Ключ клиента, принадлежащий пользователю. |
|
Тип
|
Type | string |
Тип пользователя. |
|
ProvisionType
|
ProvisionType | string |
Тип пользователя. |
|
LicenseType
|
LicenseType | string |
Тип лицензии пользователя. |
|
RobotProvision
|
RobotProvision | AttendedRobotDto | |
|
UnattendedRobot
|
UnattendedRobot | UnattendedRobotDto | |
|
NotificationSubscription
|
NotificationSubscription | UserNotificationSubscription | |
|
Key
|
Key | uuid |
Уникальный ключ для пользователя |
|
MayHaveUserSession
|
MayHaveUserSession | boolean |
Указывает, разрешено ли этому пользователю иметь сеанс пользователя (по умолчанию: true) |
|
MayHaveRobotSession
|
MayHaveRobotSession | boolean |
Указывает, разрешено ли этому пользователю присоединенный робот (по умолчанию: true) |
|
MayHaveUnattendedSession
|
MayHaveUnattendedSession | boolean |
Указывает, разрешено ли этому пользователю подключиться к автоматическому роботу (по умолчанию: false) |
|
BypassBasicAuthRestriction
|
BypassBasicAuthRestriction | boolean |
Указывает, передает ли этот пользователь параметр приложения Auth.RestrictBasicAuthentication (по умолчанию: false) |
|
MayHavePersonalWorkspace
|
MayHavePersonalWorkspace | boolean |
Указывает, разрешено ли этому пользователю иметь личную рабочую область |
|
Идентификатор
|
Id | integer |
UnattendedRobotDto
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Имя пользователя
|
UserName | string |
Имя пользователя, используемое для проверки подлинности на хост-компьютере. |
|
Пароль
|
Password | string |
Пароль, используемый для проверки подлинности на хост-компьютере. |
|
CredentialStoreId
|
CredentialStoreId | integer |
Хранилище учетных данных, используемое для хранения пароля. |
|
CredentialType
|
CredentialType | string |
Тип учетных данных робота (default/ SmartCard) |
|
CredentialExternalName
|
CredentialExternalName | string |
Содержит значение ключа во внешнем хранилище, используемом для хранения пароля. |
|
ExecutionSettings
|
ExecutionSettings | object |
Объект, содержащий параметры выполнения для робота. |
|
LimitConcurrentExecution
|
LimitConcurrentExecution | boolean |
Указывает, может ли робот использоваться одновременно на нескольких компьютерах |
|
RobotId
|
RobotId | integer |
Фактический идентификатор подготовленного робота. |
|
MachineMappingsCount
|
MachineMappingsCount | integer |
Число назначенных сопоставлений компьютеров. |
UserNotificationSubscription
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Queues
|
Queues | boolean | |
|
Роботов
|
Robots | boolean | |
|
Jobs
|
Jobs | boolean | |
|
Schedules
|
Schedules | boolean | |
|
Tasks
|
Tasks | boolean | |
|
QueueItems
|
QueueItems | boolean | |
|
Insights
|
Insights | boolean | |
|
CloudRobots
|
CloudRobots | boolean |
UserRoleDto
Хранит сведения о связи между пользователем и ролью.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
UserId
|
UserId | integer |
Идентификатор связанного пользователя. |
|
RoleId
|
RoleId | integer |
Идентификатор связанной роли. |
|
Имя пользователя
|
UserName | string |
Имя связанного пользователя |
|
RoleName
|
RoleName | string |
Имя связанной роли |
|
RoleType
|
RoleType | string | |
|
Идентификатор
|
Id | integer |