Orchestrator API - Buckets

[stch (Steffen Christensen)]

Hi,

Is it possible to use API calls to communicate with Orchestrator Storage Buckets? Specifically adding files to a existing bucket or creation of new buckets?

There are no documentation regarding bucket requests in the API documentation.

Thanks

/Steffen

[THIRU_NANI (NaNi)]

Hi!

have a view on this threads!

Orchestrator - About Storage Buckets

Create a new Bucket via API

I want to create a new Storage Bucket via API, using python, but I can’t find documentation on this topic. Basically, I can’t find the documentation that talks about the parameters to be placed in the body. url = ".../odata/Buckets" headers = {"Content-Type": "application/json", "Authorization": "Bearer xxxxxx", "X-UIPATH-OrganizationUnitID": "xxxxx"} body = {"What are the parameters?"}} session.post(url=url, ....) Can anyone tell me the documentation …

Regards,
NaNi

[stch (Steffen Christensen)]

Thanks. Swagger helped a bit, but I’m still struggling with finding out how to upload a file into a existing bucket. Specifically the path parameter of the GetWriteUri request. I can make the request if I fx type “Test” in the path parameter and then I get a blob URI, but I dont know what to do with this.

Any one who have figured out how to do this?

[THIRU_NANI (NaNi)]

Hi!

can we try this

Upload Storage File

Regards,
NaNi

[stch (Steffen Christensen)]

Hi again,

Thanks for the message, however this particullar case is not for use in Studio.

[davendra.patel]

Yes I have the same issue, I want to upload a file to a bucket using the UiPath WebApi 12.0.

There is a PUT - Updates a bucket

not sure if you can upload with this?

Any help from UiPath would be appreciated.

Regards
Davendra

[stch (Steffen Christensen)]

Hi Davendra,

I think the PUT request is to update the bucket params and not the actual file upload, but I haven’t tested it yet.

So yeah, any advice on this would be greatly appreciated

[codemonkee (Tim)]

You are looking at two API calls

1. GET /odata/Buckets({key})/UiPath.Server.Configuration.OData.GetWriteUri
   • \<orchestrator>/swagger/index.html#/Buckets/Buckets_GetWriteUriByKey
2. PUT /api/BlobFileAccess/Put?...

After calling UiPath.Server.Configuration.OData.GetWriteUri you get a Response containing a URI and Verb to make your second request. The File is then attached to the PUT Request as a Binary and sent to the Uri obtained from the first GET request.

A good way to determine what the API calls are if it is not well documented in the Support Docs or Swagger is to Inspect your Network Traffic while taking the actions in your Browser with the Orchestrator Web UI.

[stch (Steffen Christensen)]

Hi Tim,

Thanks a lot! I got a lot further, but I am still missing something.

I get that it is two separate API calls now, and I managed to figure out how to upload the file into a storage bucket.

However I think I need something in relation to the path param in the GET request. I can successfully upload a .xlsx file to the bucket, but it is just a blank file. I need to refer to a file locally on my desktop as you can in the Orchestrator Web UI. So right now I am basically just creating a blank file on the blob instead of uploading a local file to the blob.

Can you see what I am missing here? I guess it maybe has something to do with the “track” line in the network traffic inspector, which is making a POST to dc.services.visualstudio.com/v2/track?

Thanks in advance for your big help

[codemonkee (Tim)]

@stch

Can you see what I am missing here? I guess it maybe has something to do with the “track” line in the network traffic inspector, which is making a POST to dc.services.visualstudio.com/v2/track?

Track appears to just be a analytics service.

@stch

I can successfully upload a .xlsx file to the bucket, but it is just a blank file. I need to refer to a file locally on my desktop as you can in the Orchestrator Web UI. So right now I am basically just creating a blank file on the blob instead of uploading a local file to the blob.

Are you referencing the File when creating the Binary PUT request? PUT is what actually sends the file to the remote host.

You also might be able to upload it as form-data, but I haven’t tested it and not sure what the key name would be if it is usable in this case.

[davendra.patel]

Hi

Quick where to get - The BlobFile full path
for

​/odata​/Buckets({key})​/UiPath.Server.Configuration.OData.GetWriteUri

Gets a direct upload URL for BlobFile.

[davendra.patel]

I answered my own quesiton, its the bucket name !! Wasn’t that clear.

[davendra.patel]

Where are you getting

1. PUT /api/BlobFileAccess/Put?...

from?

I need to the headers to recreate please ?

Any help please.

[stch (Steffen Christensen)]

The PUT request is the URI response from your GET request.

You need this header in your PUT request.

[codemonkee (Tim)]

@stch

You need this header in your PUT request.

Is the header needed? In my limited testing my Text and EXE file uploads I did not require any special headers. Downloading the files again the files were intact.

Found this other topic on the same, in their solution they are also not passing any headers in the PUT.

Doing an api request to add a file to bucket with CURL

Finally made it. Not without UiPath TechSup This is the correct method to upload: Creating a temporal link, with an api get request where path parameter is a NAME of file, that you want to see in orchestrator storage bucket (this is the spot where i failed - thought that this parameter is a prefix folder where i want to place it); Using this CULROptions to attach file and execute the request, where $uploadfile is a path of your file at server (machine where the service is living): …

[stch (Steffen Christensen)]

When I try it is needed, otherwise a get a response like this:

<?xml version="1.0" encoding="utf-8"?>
<Error>
    <Code>MissingRequiredHeader</Code>
    <Message>An HTTP header that&apos;s mandatory for this request is not specified.
RequestId:ad410e3f-a01e-0061-3c29-037209000000
Time:2022-01-06T18:13:41.5818119Z</Message>
    <HeaderName>x-ms-blob-type</HeaderName>
</Error>

Nevertheless, I tried the binary PUT request and I was able to upload the file successfully - so thanks for your help

[codemonkee (Tim)]

Curious. What type of file were you uploading and what version of orchestrator are you running? I was testing again 2020.10.

[stch (Steffen Christensen)]

I was testing on a .xlsx file and a Cloud Orchestrator.