studio-web
2024.10
true
UiPath logo, featuring letters U and I in white
Studio Web for Automation Suite User Guide
Automation CloudAutomation Suite
Last updated Nov 11, 2024

API list

Project

This scope contains actions associated with the project (create, delete, rename).

ScopeAPIDescription
StudioWebS2S.Project.CRUDGET: /api/Project/{projectId}Get the project that matches the provided id.
GET: /api/Project/{projectId}/WorkflowCreate a new workflow file, owned by the authenticated user.
PUT: /api/Project/{projectId}/TriggerTypeUpdate a project trigger type, owned by the authenticated user.
POST: /api/Project/Update/{projectId}Update a project, owned by the authenticated user.
DELETE: /api/Project/{projectId}DeleteAsync a project, owned the authenticated user.
PUT: /api/Project/{projectId}/Lock/{lockKey}Tries to lock the project 1 minute. If the project is already locked with the same key, the lock is extended.

Workflow

This scope contains actions associated with the workflow (create, update, delete, rename, move, duplicate).

ScopeAPIDescription
StudioWebS2S.Workflow.CRUDGET: /api/Project/{projectId}/WorkflowsGets all the workflows with relative paths.
POST: /api/Project/{projectId}/WorkflowCreate a new workflow file, owned by the authenticated user.
POST: /api/Project/{projectId}/Workflow/RenameRenames a workflow file, owned by the authenticated user.
DELETE: /api/Project/{projectId}/Workflow/{workflowId}/{parentId}Deletes a workflow file, owned by the authenticated user.
POST: /api/Project/{projectId}/DeleteWorkflowsDeletes a list of workflow files, owned by the authenticated user.
POST: /api/Project/{projectId}/Workflow/DuplicateDuplicates a workflow file, owned by the authentic user.
POST: /api/Project/{projectId}/File/MoveMoves a file from a project.
POST: /api/Project/{projectId}/FolderCreate a new workflow file, owned by the authenticated user.
POST: /api/Project/{projectId}/Folder/RenameRenames a folder, owned by the authenticated user.
DELETE: /api/Project/{projectId}/Folder/{folderId}/{parentId}Deletes a folder, owned by the authenticated user.
POST: /api/Project/{projectId}/Folder/MoveMoves a folder, owned by the authenticated user.
GET: /api/WorkflowUiStateModel/{workflowId}Get the workflow Ui state.

ShareProject

This scope contains actions associated with the project's sharing permissions (share with someone, remove share, edit sharing permissions)

ScopeAPIDescription
StudioWebS2S.Share.CRUD
GET: /api/ShareProject
Gets projects shared with the current user.
POST: /api/ShareProjectShare the project with a list of users/groups.
DELETE: /api/ShareProjectRemove project shares for a list of users/groups.
GET: /api/ShareProject/UsersGets the users that have access to this project.
  • Project
  • Workflow
  • ShareProject

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.