studio-web
latest
false
- Release notes
- Getting started
- For administrators
- Designing automations
- Creating an automation from an idea
- Creating a project
- How to start an automation
- Managing project files and folders
- Connecting automations to your accounts
- Configuring activities
- Managing the activities in a project
- Passing values between activities
- Iterating through items
- Managing the data in a project
- Configuring a project to use your data
- Using file and folder resources
- Running and testing your projects
- Managing automations
- Studio Web API
- API overview
- API list
Studio Web User Guide
Last updated Sep 2, 2024
API list
This scope contains actions associated with the project (create, delete, rename).
| Scope | API | Description |
|---|---|---|
| StudioWebS2S.Project.CRUD | GET: /api/Project/{projectId} | Get the project that matches the provided id. |
GET:
/api/Project/{projectId}/Workflow | Create a new workflow file, owned by the authenticated user. | |
PUT:
/api/Project/{projectId}/TriggerType | Update 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. |
This scope contains actions associated with the workflow (create, update, delete, rename, move, duplicate).
| Scope | API | Description |
|---|---|---|
| StudioWebS2S.Workflow.CRUD | GET:
/api/Project/{projectId}/Workflows | Gets all the workflows with relative paths. |
POST:
/api/Project/{projectId}/Workflow | Create a new workflow file, owned by the authenticated user. | |
POST:
/api/Project/{projectId}/Workflow/Rename | Renames 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}/DeleteWorkflows | Deletes a list of workflow files, owned by the authenticated user. | |
POST:
/api/Project/{projectId}/Workflow/Duplicate | Duplicates a workflow file, owned by the authentic user. | |
POST:
/api/Project/{projectId}/File/Move | Moves a file from a project. | |
POST:
/api/Project/{projectId}/Folder | Create a new workflow file, owned by the authenticated user. | |
POST:
/api/Project/{projectId}/Folder/Rename | Renames 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/Move | Moves a folder, owned by the authenticated user. | |
GET:
/api/WorkflowUiStateModel/{workflowId} | Get the workflow Ui state. |
This scope contains actions associated with the project's sharing permissions (share with someone, remove share, edit sharing permissions)
| Scope | API | Description |
|---|---|---|
| StudioWebS2S.Share.CRUD |
GET:
/api/ShareProject | Gets projects shared with the current user. |
POST: /api/ShareProject | Share the project with a list of users/groups. | |
DELETE: /api/ShareProject | Remove project shares for a list of users/groups. | |
GET: /api/ShareProject/Users | Gets the users that have access to this project. |
