API and Swagger

Help Orchestrator
,
1

Hi,
I am a beginner to learn API using Swagger. Are there any examples out there that would walk me through each of the APIs and how to work on them? Can you please provide pointers? Is there a specific version of Swagger that version 2022.10 uses?

thank you,

2

@A_Learner

Tversion is 16.0 I believe…to know just use yourorchurl/swagger/index.html …version would be displayed on right top

Coming to resources swagger itself is a resource to use api…whichever you see as * in the fields can be filled and you can check the returned values and also you will get curl which can be used as a base api call that is made to get the data

Apart from That can check here

Cheers

2 Likes
3

Hi @A_Learner you can go through some youtube vidoes you will get an idea how API swagger works also you can try yourself
Go through this documentation
UiPath Add-ins Guide
Thanks
Akash Javalekar

1 Like
4

Thank you. I am trying to create a folder and trying to run post. ending up with an error. Do I need to provide user id and domain? How do I get them?

Thanks a lot,

5

Hi @A_Learner , please have a read and come back with any specific questions that you may have.

6

@A_Learner

  1. First create an external application in orcgestrator admin panel
  2. After that you would get client id and secret which can be used to get bearer token using which you can do further api calls

Note : above steps needs to be done if using api from any external app…if using studio then use orchestrator http request with relative endpoint and it should work

Links on how yo create external application are already provided above

Cheers

7

The image shows a configuration window for an Orchestrator HTTP Request with fields for folder path, method (set to PUT), relative endpoint (set to "/odata/Folders"), and JSON payload (set to "resp"). (Captioned by AI)
The image shows a configuration window for an Orchestrator HTTP Request with fields for folder path, method (set to PUT), relative endpoint (set to "/odata/Folders"), and JSON payload (set to "resp"). (Captioned by AI)893Ă—644 13.6 KB

Kindly advise why it is giving me 405 error

8

@A_Learner

If you want to get all folders then get method is to be used and not put

Cheers

9

Thank you. I am trying to create a new folder.

Regards,

10

Hey @A_Learner! :slight_smile:

Since your screenshot looks like you’re working in Studio, why don’t you use the Swagger UI first, as you mentioned you want to play around with it?

Here’s how you can get there:

image

Then simply “authorize.”

image

Hope this helps!

Cheers!

11

@A_Learner

then it should be post

cheers

12

Can you advise on the Json pay load the activity is expecting?

The image shows an Orchestrator HTTP Request configuration screen with fields for Orchestrator folder path, HTTP method, relative endpoint, and JSON payload, highlighting a required VB expression for the JSON Payload. (Captioned by AI)
The image shows an Orchestrator HTTP Request configuration screen with fields for Orchestrator folder path, HTTP method, relative endpoint, and JSON payload, highlighting a required VB expression for the JSON Payload. (Captioned by AI)884Ă—852 22.4 KB

Thank you,

13

@Julian_Muhlbauer
Trying Delete from Swagger UI, getting 401 error. What am I missing?

This image displays a user interface for a Delete Folder API endpoint, showing the necessary parameters, permissions, and scopes required to execute the delete action. (Captioned by AI)
This image displays a user interface for a Delete Folder API endpoint, showing the necessary parameters, permissions, and scopes required to execute the delete action. (Captioned by AI)3688Ă—1349 185 KB

14

@A_Learner

The image displays a JSON schema for a "FolderDto" object, detailing various attributes such as "Key", "DisplayName", "FullyQualifiedName", "Description", "FolderType", "ProvisionType", "PermissionModel", "ParentId", "ParentKey", "FeedType", and "Id". (Captioned by AI)
The image displays a JSON schema for a "FolderDto" object, detailing various attributes such as "Key", "DisplayName", "FullyQualifiedName", "Description", "FolderType", "ProvisionType", "PermissionModel", "ParentId", "ParentKey", "FeedType", and "Id". (Captioned by AI)828Ă—638 50.3 KB

If you see seagger you would see full load …

Cheers

1 Like
15

@Anil_G so do I need to fill this up and execute the request?
thank you

16

@A_Learner

Yes click example values…you can send the required values remaining can be removed

That would be your json payload

Cheers

17

@Anil_G
For some requests for example, create folder - POST- " /odata/folders"
I update the example with display name and execute. It gives me “404” error. I do not understand, how to sort through the errors. Thank you,

18

@A_Learner

Can you show a screenshot of response

cheers

20

@Anil_G

The image shows a 404 error response from a server, indicating "an error has occurred" and including details of the response body and headers. (Captioned by AI)
The image shows a 404 error response from a server, indicating "an error has occurred" and including details of the response body and headers. (Captioned by AI)3488Ă—1726 458 KB

21

@A_Learner

can you show the json payload you sent as well

may be the values are wrong there

cheers