ストレージ バケットの要求

ストレージ バケットへファイルを追加する

Orchestrator API を使用して既存のストレージ バケットにファイルをアップロードするプロセスは、次の 2 つの部分で構成されます。

• まず、URI と HTTP メソッドを応答として返す GET /odata/Buckets({key})/UiPath.Server.Configuration.OData.GetWriteUri エンドポイントを呼び出す必要があります。
• 次に、GET 応答の HTTP メソッドを使用して {URI} エンドポイントを呼び出し、アップロードするファイルをバイナリ形式で添付し、GET 要求から取得した URI に送信する必要があります。

Note: External applications must include the OR.Administration scope in order to upload files to an existing storage bucket. This scope provides the storage permissions needed for upload operations.

GET エンドポイント

GET https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/Buckets({key})/UiPath.Server.Configuration.OData.GetWriteUri

URI と HTTP 動詞を確認するには、ファイルを既存のストレージ バケットにアップロードしてから、GET 要求を /odata/Buckets({key})/UiPath.Server.Configuration.OData.GetWriteUri に送信する必要があります。

次のパラメーターとヘッダーを指定します。

パス パラメーター

パス パラメーター	データ型	説明
key (必須)	文字列	ファイルのアップロード先のストレージ バケットの ID です。

クエリ パラメーター

パラメーター	データ型	説明
path (必須)	文字列	アップロードするファイルの名前と拡張子です。 たとえば、「my_file.txt」です。
contentType (必須)	文字列	ファイル拡張子に対応するコンテンツの種類です。 たとえば、拡張子 .txt のコンテンツの種類は text/plain です。

要求ヘッダー

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json' \
--header 'X-UIPATH-OrganizationUnitId: {the_ID_of_the_folder_that_contains_the_storage_bucket}' \

X-UIPATH-OrganizationUnitId は、ストレージ バケットを含むフォルダーの ID です。

要求の例

curl --location --request GET 'https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/Buckets(28053)/UiPath.Server.Configuration.OData.GetWriteUri?path=my_file.txt&contentType=text/plain' \
--header 'x-uipath-organizationunitid: 3991326' \
--header 'Authorization: Bearer 1234'

この例のアクセス トークンは、長さを考慮して 1234 になっています。

応答本文

応答本文には、ファイルをストレージ バケットにバイナリ形式でアップロードするために必要な URI と HTTP 動詞が含まれます。

{
    "@odata.context": "https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#UiPath.Server.Configuration.OData.BlobFileAccessDto",
    "Uri": "https://cr.blob.core.windows.net/orchestrator-4871-905f/BlobFilePersistence/2760e0fe-0fa7/my_file.txt?sv=2021-08-06&st=2023-01-13T16%3A32%3A12Z&se=2023-01-13T17%3A32%3A42Z&sr=b&sp=cw&sig=xB3W02xGYHfw%3D",
    "Verb": "PUT",
    "Headers": {
        "Keys": [
            "x-ms-blob-type"
        ],
        "Values": [
            "BlockBlob"
        ]
    }
}

PUT エンドポイント

PUT {URI}

URI は、応答本文の「Uri」キーの値です。

要求ヘッダー

--header 'x-ms-blob-type: BlockBlob' \
--header 'Content-Type: text/plain'

注:

• 必ず GET 応答本文で受信したヘッダーを含め、そのヘッダーに値を割り当ててください。たとえば、Azure Blob Storage の場合、返されるヘッダーは x-ms-blob-type-header で、値 BlockBlob が使用されます。
• この要求で認可ヘッダーを使用しないでください。

要求本文

ファイルをバイナリ形式でアップロードします。GET 要求でクエリ パラメーターとして使用したファイルと同じファイルを使用する必要があります。この場合は、「my_file.txt」です。

--data-binary '@/C:/Users/adam.eve/OneDrive/Documents/my_file.txt'

要求の例

API 呼び出しの構築に必要な情報をすべて収集したとします。

curl --location --request PUT 'https://cr.blob.core.windows.net/orchestrator-4871-905f/BlobFilePersistence/2760e0fe-0fa7/my_file.txt?sv=2021-08-06&st=2023-01-13T16%3A32%3A12Z&se=2023-01-13T17%3A32%3A42Z&sr=b&sp=cw&sig=xB3W02xGYHfw%3D' \
--header 'x-ms-blob-type: BlockBlob' \
--header 'Content-Type: text/plain' \
--data-binary '@/C:/Users/adam.eve/OneDrive/Documents/my_file.txt'

Orchestrator の UI のストレージ バケットにファイルが表示されます。