orchestrator
2024.10
true
- 入门指南
- 身份验证
- Swagger 定义
- Orchestrator API
- 平台管理 API
Orchestrator API 指南
Last updated 2024年10月21日
包请求
获取
https://{yourDomain}/odata/Processes/UiPath.Server.Configuration.OData.GetProcessVersions(processId='QueueItemsProcessing')
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Processes",
"@odata.count": 2,
"value": [
{
"IsActive": true,
"SupportsMultipleEntryPoints": false,
"MainEntryPointPath": null,
"RequiresUserInteraction": true,
"TargetFramework": "Legacy",
"Title": null,
"Version": "1.0.6981.35861",
"Key": "QueueItemsProcessing:1.0.6981.35861",
"Description": "Process items from an Orchestrator queue.",
"Published": "2021-07-23T16:40:07.793Z",
"IsLatestVersion": false,
"OldVersion": null,
"ReleaseNotes": null,
"Authors": "petrina.calota",
"ProjectType": "Undefined",
"Tags": null,
"Id": "QueueItemsProcessing",
"Arguments": {
"Input": "[{\"name\":\"argument1\",\"type\":\"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":true},{\"name\":\"argument2\",\"type\":\"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":false},{\"name\":\"argument3\",\"type\":\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":true}]",
"Output": null
}
}
]
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Processes",
"@odata.count": 2,
"value": [
{
"IsActive": true,
"SupportsMultipleEntryPoints": false,
"MainEntryPointPath": null,
"RequiresUserInteraction": true,
"TargetFramework": "Legacy",
"Title": null,
"Version": "1.0.6981.35861",
"Key": "QueueItemsProcessing:1.0.6981.35861",
"Description": "Process items from an Orchestrator queue.",
"Published": "2021-07-23T16:40:07.793Z",
"IsLatestVersion": false,
"OldVersion": null,
"ReleaseNotes": null,
"Authors": "petrina.calota",
"ProjectType": "Undefined",
"Tags": null,
"Id": "QueueItemsProcessing",
"Arguments": {
"Input": "[{\"name\":\"argument1\",\"type\":\"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":true},{\"name\":\"argument2\",\"type\":\"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":false},{\"name\":\"argument3\",\"type\":\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":true}]",
"Output": null
}
}
]
}
以下对
/odata/Processes/UiPath.Server.Configuration.OData.GetArguments(key='key')
端点的 GET 请求将返回特定包的所有 In 和 Out 参数、其类型以及它们是否具有默认值。 项目的“输入”、“输出”或“输入/输出”参数将成为 Orchestrator 中的输入和输出参数。
获取
https://{yourDomain}/odata/Processes/UiPath.Server.Configuration.OData.GetArguments(key='input_output_test%3A1.3.5')
{
"@odata.context": "https://{yourDomain}/odata/$metadata#UiPath.Core.Arguments.ArgumentMetadata",
"Input": "[\r\n {\r\n \"name\": \"age\",\r\n \"type\": \"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n \"required\": false,\r\n \"hasDefault\": false\r\n },\r\n {\r\n \"name\": \"Array\",\r\n \"type\": \"System.Int32[], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n \"required\": false,\r\n \"hasDefault\": true\r\n },\r\n {\r\n \"name\": \"trueOrFalse\",\r\n \"type\": \"System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n \"required\": false,\r\n \"hasDefault\": true\r\n },\r\n {\r\n \"name\": \"dateNow\",\r\n \"type\": \"System.DateTime, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n \"required\": false,\r\n \"hasDefault\": true\r\n },\r\n {\r\n \"name\": \"stringNew\",\r\n \"type\": \"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n \"required\": false,\r\n \"hasDefault\": false\r\n },\r\n {\r\n \"name\": \"arrayStrings\",\r\n \"type\": \"System.String[], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n \"required\": false,\r\n \"hasDefault\": false\r\n },\r\n {\r\n \"name\": \"inOutTry\",\r\n \"type\": \"System.Object, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n \"required\": false,\r\n \"hasDefault\": false\r\n }\r\n]",
"Output": "[\r\n {\r\n \"name\": \"output\",\r\n \"type\": \"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\"\r\n },\r\n {\r\n \"name\": \"inOutTry\",\r\n \"type\": \"System.Object, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\"\r\n }\r\n]"
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#UiPath.Core.Arguments.ArgumentMetadata",
"Input": "[\r\n {\r\n \"name\": \"age\",\r\n \"type\": \"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n \"required\": false,\r\n \"hasDefault\": false\r\n },\r\n {\r\n \"name\": \"Array\",\r\n \"type\": \"System.Int32[], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n \"required\": false,\r\n \"hasDefault\": true\r\n },\r\n {\r\n \"name\": \"trueOrFalse\",\r\n \"type\": \"System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n \"required\": false,\r\n \"hasDefault\": true\r\n },\r\n {\r\n \"name\": \"dateNow\",\r\n \"type\": \"System.DateTime, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n \"required\": false,\r\n \"hasDefault\": true\r\n },\r\n {\r\n \"name\": \"stringNew\",\r\n \"type\": \"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n \"required\": false,\r\n \"hasDefault\": false\r\n },\r\n {\r\n \"name\": \"arrayStrings\",\r\n \"type\": \"System.String[], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n \"required\": false,\r\n \"hasDefault\": false\r\n },\r\n {\r\n \"name\": \"inOutTry\",\r\n \"type\": \"System.Object, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\r\n \"required\": false,\r\n \"hasDefault\": false\r\n }\r\n]",
"Output": "[\r\n {\r\n \"name\": \"output\",\r\n \"type\": \"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\"\r\n },\r\n {\r\n \"name\": \"inOutTry\",\r\n \"type\": \"System.Object, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\"\r\n }\r\n]"
}
通过向
/odata/Processes/UiPath.Server.Configuration.OData.SetArguments
端点发出 POST 请求,可以更新项目的输入和输出参数。
备注:
此调用将覆盖所有先前的参数并提供验证。
此外,请注意,只有当您 未 通过 API、“ 包 ”页面或 NuGet 订阅源将自动化包上传到 Orchestrator 时,此端点才能用于更改自动化包的输入和输出参数。
发布
https://{yourDomain}/odata/Processes/UiPath.Server.Configuration.OData.SetArguments
{
"key": "input_output_test:1.3.6",
"arguments": {
"Input": "[{\"name\":\"arg1\", \"type\": \"System.String\", \"required\": false}]",
"Output": "[{\"name\":\"outputArg\", \"type\":\"System.String\", \"required\":false}]"
}
}
{
"key": "input_output_test:1.3.6",
"arguments": {
"Input": "[{\"name\":\"arg1\", \"type\": \"System.String\", \"required\": false}]",
"Output": "[{\"name\":\"outputArg\", \"type\":\"System.String\", \"required\":false}]"
}
}
获取
https://{yourDomain}/odata/Processes
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Processes",
"@odata.count": 2,
"value": [
{
"IsActive": false,
"SupportsMultipleEntryPoints": false,
"MainEntryPointPath": null,
"RequiresUserInteraction": true,
"TargetFramework": "Legacy",
"Title": null,
"Version": "1.0.6981.35861",
"Key": "QueueItemsProcessing:1.0.6981.35861",
"Description": "Process items from an Orchestrator queue.",
"Published": "2021-07-23T16:40:07.7933333Z",
"IsLatestVersion": false,
"OldVersion": null,
"ReleaseNotes": null,
"Authors": "petrina.calota",
"ProjectType": "Undefined",
"Tags": null,
"Id": "QueueItemsProcessing",
"Arguments": {
"Input": "[{\"name\":\"argument1\",\"type\":\"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":true},{\"name\":\"argument2\",\"type\":\"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":false},{\"name\":\"argument3\",\"type\":\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":true}]",
"Output": null
}
}
]
}
{
"@odata.context": "https://{yourDomain}/odata/$metadata#Processes",
"@odata.count": 2,
"value": [
{
"IsActive": false,
"SupportsMultipleEntryPoints": false,
"MainEntryPointPath": null,
"RequiresUserInteraction": true,
"TargetFramework": "Legacy",
"Title": null,
"Version": "1.0.6981.35861",
"Key": "QueueItemsProcessing:1.0.6981.35861",
"Description": "Process items from an Orchestrator queue.",
"Published": "2021-07-23T16:40:07.7933333Z",
"IsLatestVersion": false,
"OldVersion": null,
"ReleaseNotes": null,
"Authors": "petrina.calota",
"ProjectType": "Undefined",
"Tags": null,
"Id": "QueueItemsProcessing",
"Arguments": {
"Input": "[{\"name\":\"argument1\",\"type\":\"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":true},{\"name\":\"argument2\",\"type\":\"System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":false},{\"name\":\"argument3\",\"type\":\"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\",\"required\":false,\"hasDefault\":true}]",
"Output": null
}
}
]
}