UiPath Documentation
orchestrator
2022.10
false
Orchestrator API ガイド
重要 :
このコンテンツの一部は機械翻訳によって処理されており、完全な翻訳を保証するものではありません。 新しいコンテンツの翻訳は、およそ 1 ～ 2 週間で公開されます。

パッケージの要求

特定のパッケージの利用可能なバージョンをすべて取得する​

GET

https://{yourDomain}/odata/Processes/UiPath.Server.Configuration.OData.GetProcessVersions(processId='QueueItemsProcessing')

要求ヘッダー​

キー値 (Value)
認可Bearer

応答コード​

200 OK

応答本文​

{
  "@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
            }
        }
    ]
}

特定のパッケージ バージョンをダウンロードする​

以下の要求では、名前が「add_queue_items」で、バージョンが 1.0.6654.27080 のパッケージをダウンロードできます。

GET

https://{yourDomain}/odata/Processes/UiPath.Server.Configuration.OData.DownloadPackage(key='add_queue_items:1.0.6654.27080')

要求ヘッダー​

キー値 (Value)
認可Bearer

応答コード​

200 OK

パッケージの引数を取得する​

/odata/Processes/UiPath.Server.Configuration.OData.GetArguments(key='key') エンドポイントへの次の GET 要求は、特定のパッケージのすべての入力引数と出力引数、その型、および既定値の有無を返します。プロジェクトの入力引数、出力引数、入力/出力引数は、Orchestrator の入力パラメーターと出力パラメーターになります。

GET

https://{yourDomain}/odata/Processes/UiPath.Server.Configuration.OData.GetArguments(key='input_output_test%3A1.3.5')

要求ヘッダー​

キー値 (Value)
認可Bearer

応答コード​

200 OK

応答本文​

{
    "@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 要求を送信して、プロジェクトの入力パラメーターと出力パラメーターを更新できます。

注:

この呼び出しは、前のパラメーターをすべて上書きし、検証機能を提供します。

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.

入力パラメーターの値のみを更新する場合は、 プロセス レベル、 ジョブ レベル、および/または スケジュール レベルで 更新できます。

POST

https://{yourDomain}/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

パッケージを取得する​

GET

https://{yourDomain}/odata/Processes

要求ヘッダー​

キー値 (Value)
認可Bearer

応答コード​

200 OK

応答本文​

{
  "@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
            }
        }
    ]
}

このページは役に立ちましたか?

接続

ヘルプ リソース サポート

学習する UiPath アカデミー

質問する UiPath フォーラム

最新情報を取得