- 基本情報
- Swagger の定義
- Orchestrator API
特定のパッケージの利用可能なバージョンをすべて取得する
GET
{OrchestratorURL}/odata/Processes/UiPath.Server.Configuration.OData.GetProcessVersions(processId='input_output_arguments_example')
要求ヘッダー
| キー | 値 (Value) |
|---|---|
| 認可 | Bearer |
応答コード
200 OK
応答本文
{
"@odata.context": "{OrchestratorURL}/odata/$metadata#Processes",
"@odata.count": 2,
"value": [
{
"IsActive": true,
"Title": null,
"Version": "1.0.3",
"Key": "input_output_arguments_example:1.0.3",
"Description": "Blank Process",
"Published": "2018-10-09T10:04:33.4667132Z",
"IsLatestVersion": true,
"OldVersion": null,
"ReleaseNotes": null,
"Authors": "madalina.boboc",
"Id": "input_output_arguments_example",
"Arguments": {
"Input": "[\r\n {\r\n \"name\": \"LinkedInUsername\",\r\n \"type\": \"System.String, 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\": \"LinkedInPassword\",\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]",
"Output": "[\r\n {\r\n \"name\": \"ExtractedDataTable\",\r\n \"type\": \"System.Data.DataTable, System.Data, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\"\r\n }\r\n]"
}
},
{
"IsActive": false,
"Title": null,
"Version": "1.0.2",
"Key": "input_output_arguments_example:1.0.2",
"Description": "Blank Process",
"Published": "2018-09-07T15:53:36.4774871Z",
"IsLatestVersion": false,
"OldVersion": null,
"ReleaseNotes": null,
"Authors": "madalina.boboc",
"Id": "input_output_arguments_example",
"Arguments": null
}
]
}
{
"@odata.context": "{OrchestratorURL}/odata/$metadata#Processes",
"@odata.count": 2,
"value": [
{
"IsActive": true,
"Title": null,
"Version": "1.0.3",
"Key": "input_output_arguments_example:1.0.3",
"Description": "Blank Process",
"Published": "2018-10-09T10:04:33.4667132Z",
"IsLatestVersion": true,
"OldVersion": null,
"ReleaseNotes": null,
"Authors": "madalina.boboc",
"Id": "input_output_arguments_example",
"Arguments": {
"Input": "[\r\n {\r\n \"name\": \"LinkedInUsername\",\r\n \"type\": \"System.String, 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\": \"LinkedInPassword\",\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]",
"Output": "[\r\n {\r\n \"name\": \"ExtractedDataTable\",\r\n \"type\": \"System.Data.DataTable, System.Data, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\"\r\n }\r\n]"
}
},
{
"IsActive": false,
"Title": null,
"Version": "1.0.2",
"Key": "input_output_arguments_example:1.0.2",
"Description": "Blank Process",
"Published": "2018-09-07T15:53:36.4774871Z",
"IsLatestVersion": false,
"OldVersion": null,
"ReleaseNotes": null,
"Authors": "madalina.boboc",
"Id": "input_output_arguments_example",
"Arguments": null
}
]
}
Downloading a Specific Package Version
以下の要求では、名前が「add_queue_items」で、バージョンが 1.0.6654.27080 のパッケージをダウンロードできます。
GET
{OrchestratorURL}/odata/Processes/UiPath.Server.Configuration.OData.DownloadPackage(key='add_queue_items:1.0.6654.27080')
要求ヘッダー
| キー | 値 (Value) |
|---|---|
| 認可 | Bearer |
応答コード
200 OK
Retrieving the Arguments of a Package
/odata/Processes/UiPath.Server.Configuration.OData.GetArguments(key='key') エンドポイントへの次の GET 要求は、特定のパッケージのすべての入力引数と出力引数、その型、および既定値の有無を返します。プロジェクトの入力引数、出力引数、入力/出力引数は、Orchestrator の入力パラメーターと出力パラメーターになります。
GET
{OrchestratorURL}/odata/Processes/UiPath.Server.Configuration.OData.GetArguments(key='input_output_test%3A1.3.5')
要求ヘッダー
| キー | 値 (Value) |
|---|---|
| 認可 | Bearer |
応答コード
200 OK
応答本文
{
"@odata.context": "{OrchestratorURL}/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": "{OrchestratorURL}/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 要求を送信して、プロジェクトの入力パラメーターと出力パラメーターを更新できます。
この呼び出しは、前のパラメーターをすべて上書きし、検証機能を提供します。
Additionally, please note that this endpoint can be used to change the input and output parameters of an automation package only if you did not upload it to Orchestrator through the API, the Packages page, or the NuGet feed.
If you want to update the values of input parameters only, you can do so at process level, at job level, and/or schedule level.
POST
{OrchestratorURL}/odata/Processes/UiPath.Server.Configuration.OData.SetArguments
要求ヘッダー
| キー | 値 (Value) |
|---|---|
| 認可 | Bearer |
要求本文
{
"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}]"
}
}
応答コード
200 OK