# API Designer Experience API

Design and manage API specifications and fragments in Design Center. Create projects, manage branches, modify files, and publish to Exchange.

- **Version:** 1.0.0
- **Category:** Design
- **OpenAPI Spec:** [api.yaml](https://dev-portal.mulesoft.com/apis/api-designer-experience/api.yaml)

## Servers
- `https://anypoint.mulesoft.com/designcenter/api-designer`
- `https://{region}.anypoint.mulesoft.com/designcenter/api-designer`
- `https://{region}.platform.mulesoft.com/designcenter/api-designer`

## Operations (35)
### GET /ping

**Operation ID:** `getPing`
to check if service is up

### GET /status

**Operation ID:** `getStatus`
to check if service is up

### GET /projects

**Operation ID:** `getProjects`
Gets all the projects that the user has access

**Parameters:**
| `x-owner-id` | query | User's ownerId, which identifies the user performing the operation. 
This is NOT the username, but an UUID that can be found in the users page by the organization administrator.
 | required |
| `x-organization-id` | query | OrganizationId, which identifies the organization to which perform the operation. 
This can be found in the organizations page by the organization administrator.
 | required |
| `authorization` | query | Bearer Access Token | required |

### POST /projects

**Operation ID:** `createProjects`
Creates a new project

**Parameters:**
| `x-owner-id` | query | User's ownerId, which identifies the user performing the operation. 
This is NOT the username, but an UUID that can be found in the users page by the organization administrator.
 | required |
| `x-organization-id` | query | OrganizationId, which identifies the organization to which perform the operation. 
This can be found in the organizations page by the organization administrator.
 | required |
| `authorization` | query | Bearer Access Token | required |

### POST /projects/import

**Operation ID:** `createProjectsImport`
Creates a project from a zip file containing files

**Parameters:**
| `x-owner-id` | query | User's ownerId, which identifies the user performing the operation. 
This is NOT the username, but an UUID that can be found in the users page by the organization administrator.
 | required |
| `x-organization-id` | query | OrganizationId, which identifies the organization to which perform the operation. 
This can be found in the organizations page by the organization administrator.
 | required |
| `authorization` | query | Bearer Access Token | required |

### GET /projects/{projectId}

**Operation ID:** `getProjectsByProjectid`
Get project data

**Parameters:**
| `projectId` | query | Project unique ID | required |
| `x-owner-id` | query | User's ownerId, which identifies the user performing the operation. 
This is NOT the username, but an UUID that can be found in the users page by the organization administrator.
 | required |
| `x-organization-id` | query | OrganizationId, which identifies the organization to which perform the operation. 
This can be found in the organizations page by the organization administrator.
 | required |
| `authorization` | query | Bearer Access Token | required |

### PATCH /projects/{projectId}

**Operation ID:** `patchProjectsByProjectid`
Patches project metadata.
CreatedBy is only editable by the Project Owner or Organization Admins


**Parameters:**
| `projectId` | query | Project unique ID | required |
| `x-owner-id` | query | User's ownerId, which identifies the user performing the operation. 
This is NOT the username, but an UUID that can be found in the users page by the organization administrator.
 | required |
| `x-organization-id` | query | OrganizationId, which identifies the organization to which perform the operation. 
This can be found in the organizations page by the organization administrator.
 | required |
| `authorization` | query | Bearer Access Token | required |

### DELETE /projects/{projectId}

**Operation ID:** `deleteProjectsByProjectid`
Deletes the given project

**Parameters:**
| `projectId` | query | Project unique ID | required |
| `x-owner-id` | query | User's ownerId, which identifies the user performing the operation. 
This is NOT the username, but an UUID that can be found in the users page by the organization administrator.
 | required |
| `x-organization-id` | query | OrganizationId, which identifies the organization to which perform the operation. 
This can be found in the organizations page by the organization administrator.
 | required |
| `authorization` | query | Bearer Access Token | required |

### GET /projects/{projectId}/branches

**Operation ID:** `getProjectsByProjectidBranches`
List branches

**Parameters:**
| `projectId` | query | Project unique ID | required |
| `x-owner-id` | query | User's ownerId, which identifies the user performing the operation. 
This is NOT the username, but an UUID that can be found in the users page by the organization administrator.
 | required |
| `x-organization-id` | query | OrganizationId, which identifies the organization to which perform the operation. 
This can be found in the organizations page by the organization administrator.
 | required |
| `authorization` | query | Bearer Access Token | required |

### POST /projects/{projectId}/branches

**Operation ID:** `createProjectsByProjectidBranches`
Creates new branch

**Parameters:**
| `projectId` | query | Project unique ID | required |
| `x-owner-id` | query | User's ownerId, which identifies the user performing the operation. 
This is NOT the username, but an UUID that can be found in the users page by the organization administrator.
 | required |
| `x-organization-id` | query | OrganizationId, which identifies the organization to which perform the operation. 
This can be found in the organizations page by the organization administrator.
 | required |
| `authorization` | query | Bearer Access Token | required |

### DELETE /projects/{projectId}/branches/{branch}

**Operation ID:** `deleteProjectsByProjectidBranchesByBranch`
Deletes a branch

**Parameters:**
| `projectId` | query | Project unique ID | required |
| `branch` | query | Branch name to which apply a given operation | required |
| `x-owner-id` | query | User's ownerId, which identifies the user performing the operation. 
This is NOT the username, but an UUID that can be found in the users page by the organization administrator.
 | required |
| `x-organization-id` | query | OrganizationId, which identifies the organization to which perform the operation. 
This can be found in the organizations page by the organization administrator.
 | required |
| `authorization` | query | Bearer Access Token | required |

### POST /projects/{projectId}/branches/{branch}/open

**Operation ID:** `createProjectsByProjectidBranchesByBranchOpen`
List project files. If user's workingDir does not exists, it creates one.

**Parameters:**
| `projectId` | query | Project unique ID | required |
| `branch` | query | Branch name to which apply a given operation | required |
| `x-owner-id` | query | User's ownerId, which identifies the user performing the operation. 
This is NOT the username, but an UUID that can be found in the users page by the organization administrator.
 | required |
| `x-organization-id` | query | OrganizationId, which identifies the organization to which perform the operation. 
This can be found in the organizations page by the organization administrator.
 | required |
| `authorization` | query | Bearer Access Token | required |

### POST /projects/{projectId}/branches/{branch}/clean

**Operation ID:** `createProjectsByProjectidBranchesByBranchClean`
cleans uncommited files from users workingDir

**Parameters:**
| `projectId` | query | Project unique ID | required |
| `branch` | query | Branch name to which apply a given operation | required |
| `x-owner-id` | query | User's ownerId, which identifies the user performing the operation. 
This is NOT the username, but an UUID that can be found in the users page by the organization administrator.
 | required |
| `x-organization-id` | query | OrganizationId, which identifies the organization to which perform the operation. 
This can be found in the organizations page by the organization administrator.
 | required |
| `authorization` | query | Bearer Access Token | required |

### GET /projects/{projectId}/branches/{branch}/status

**Operation ID:** `getProjectsByProjectidBranchesByBranchStatus`
list WorkingDir status

**Parameters:**
| `projectId` | query | Project unique ID | required |
| `branch` | query | Branch name to which apply a given operation | required |
| `x-owner-id` | query | User's ownerId, which identifies the user performing the operation. 
This is NOT the username, but an UUID that can be found in the users page by the organization administrator.
 | required |
| `x-organization-id` | query | OrganizationId, which identifies the organization to which perform the operation. 
This can be found in the organizations page by the organization administrator.
 | required |
| `authorization` | query | Bearer Access Token | required |

### POST /projects/{projectId}/branches/{branch}/save

**Operation ID:** `createProjectsByProjectidBranchesByBranchSave`
save listed files (save and save All)

**Parameters:**
| `projectId` | query | Project unique ID | required |
| `branch` | query | Branch name to which apply a given operation | required |
| `x-owner-id` | query | User's ownerId, which identifies the user performing the operation. 
This is NOT the username, but an UUID that can be found in the users page by the organization administrator.
 | required |
| `x-organization-id` | query | OrganizationId, which identifies the organization to which perform the operation. 
This can be found in the organizations page by the organization administrator.
 | required |
| `authorization` | query | Bearer Access Token | required |

### POST /projects/{projectId}/branches/{branch}/save/v2

**Operation ID:** `createProjectsByProjectidBranchesByBranchSaveV2`
Save listed files (save and save All).
Accepts any file as body's content-type can be multipart/form-data


**Parameters:**
| `projectId` | query | Project unique ID | required |
| `branch` | query | Branch name to which apply a given operation | required |
| `x-owner-id` | query | User's ownerId, which identifies the user performing the operation. 
This is NOT the username, but an UUID that can be found in the users page by the organization administrator.
 | required |
| `x-organization-id` | query | OrganizationId, which identifies the organization to which perform the operation. 
This can be found in the organizations page by the organization administrator.
 | required |
| `authorization` | query | Bearer Access Token | required |

### GET /projects/{projectId}/branches/{branch}/files

**Operation ID:** `getProjectsByProjectidBranchesByBranchFiles`
Gets a list of the structure of the file system (open project)

**Parameters:**
| `projectId` | query | Project unique ID | required |
| `branch` | query | Branch name to which apply a given operation | required |
| `x-owner-id` | query | User's ownerId, which identifies the user performing the operation. 
This is NOT the username, but an UUID that can be found in the users page by the organization administrator.
 | required |
| `x-organization-id` | query | OrganizationId, which identifies the organization to which perform the operation. 
This can be found in the organizations page by the organization administrator.
 | required |
| `authorization` | query | Bearer Access Token | required |

### GET /projects/{projectId}/branches/{branch}/files/v2/{filePath}

**Operation ID:** `getProjectsByProjectidBranchesByBranchFilesV2ByFilepath`
Returns the given file (getFile) with content-type according to file's content

**Parameters:**
| `projectId` | query | Project unique ID | required |
| `branch` | query | Branch name to which apply a given operation | required |
| `filePath` | query | File Path to retrieve. Must be URI complain and escape '/' characters | required |
| `x-owner-id` | query | User's ownerId, which identifies the user performing the operation. 
This is NOT the username, but an UUID that can be found in the users page by the organization administrator.
 | required |
| `x-organization-id` | query | OrganizationId, which identifies the organization to which perform the operation. 
This can be found in the organizations page by the organization administrator.
 | required |
| `authorization` | query | Bearer Access Token | required |

### GET /projects/{projectId}/branches/{branch}/files/{filePath}

**Operation ID:** `getProjectsByProjectidBranchesByBranchFilesByFilepath`
Returns the given file (getFile) in application/json format

**Parameters:**
| `projectId` | query | Project unique ID | required |
| `branch` | query | Branch name to which apply a given operation | required |
| `filePath` | query | File Path to retrieve. Must be URI complain and escape '/' characters | required |
| `x-owner-id` | query | User's ownerId, which identifies the user performing the operation. 
This is NOT the username, but an UUID that can be found in the users page by the organization administrator.
 | required |
| `x-organization-id` | query | OrganizationId, which identifies the organization to which perform the operation. 
This can be found in the organizations page by the organization administrator.
 | required |
| `authorization` | query | Bearer Access Token | required |

### DELETE /projects/{projectId}/branches/{branch}/files/{filePath}

**Operation ID:** `deleteProjectsByProjectidBranchesByBranchFilesByFilepath`
Deletes the given file or folder and commit changes (deleteFile)

**Parameters:**
| `projectId` | query | Project unique ID | required |
| `branch` | query | Branch name to which apply a given operation | required |
| `filePath` | query | File Path to retrieve. Must be URI complain and escape '/' characters | required |
| `x-owner-id` | query | User's ownerId, which identifies the user performing the operation. 
This is NOT the username, but an UUID that can be found in the users page by the organization administrator.
 | required |
| `x-organization-id` | query | OrganizationId, which identifies the organization to which perform the operation. 
This can be found in the organizations page by the organization administrator.
 | required |
| `authorization` | query | Bearer Access Token | required |

### POST /projects/{projectId}/branches/{branch}/files/{filePath}/move

**Operation ID:** `createProjectsByProjectidBranchesByBranchFilesByFilepathMove`
renames the file or folder (move or rename)

**Parameters:**
| `projectId` | query | Project unique ID | required |
| `branch` | query | Branch name to which apply a given operation | required |
| `filePath` | query | File Path to retrieve. Must be URI complain and escape '/' characters | required |
| `x-owner-id` | query | User's ownerId, which identifies the user performing the operation. 
This is NOT the username, but an UUID that can be found in the users page by the organization administrator.
 | required |
| `x-organization-id` | query | OrganizationId, which identifies the organization to which perform the operation. 
This can be found in the organizations page by the organization administrator.
 | required |
| `authorization` | query | Bearer Access Token | required |

### POST /projects/{projectId}/branches/{branch}/acquireLock

**Operation ID:** `createProjectsByProjectidBranchesByBranchAcquirelock`
Acquire lock for given project

**Parameters:**
| `projectId` | query | Project unique ID | required |
| `branch` | query | Branch name to which apply a given operation | required |
| `x-owner-id` | query | User's ownerId, which identifies the user performing the operation. 
This is NOT the username, but an UUID that can be found in the users page by the organization administrator.
 | required |
| `x-organization-id` | query | OrganizationId, which identifies the organization to which perform the operation. 
This can be found in the organizations page by the organization administrator.
 | required |
| `authorization` | query | Bearer Access Token | required |

### POST /projects/{projectId}/branches/{branch}/releaseLock

**Operation ID:** `createProjectsByProjectidBranchesByBranchReleaselock`
Release lock for given project

**Parameters:**
| `projectId` | query | Project unique ID | required |
| `branch` | query | Branch name to which apply a given operation | required |
| `x-owner-id` | query | User's ownerId, which identifies the user performing the operation. 
This is NOT the username, but an UUID that can be found in the users page by the organization administrator.
 | required |
| `x-organization-id` | query | OrganizationId, which identifies the organization to which perform the operation. 
This can be found in the organizations page by the organization administrator.
 | required |
| `authorization` | query | Bearer Access Token | required |

### POST /projects/{projectId}/branches/{branch}/publish/platform

**Operation ID:** `createProjectsByProjectidBranchesByBranchPublishPlatform`
Publish project to Api Platform

**Parameters:**
| `projectId` | query | Project unique ID | required |
| `branch` | query | Branch name to which apply a given operation | required |
| `x-owner-id` | query | User's ownerId, which identifies the user performing the operation. 
This is NOT the username, but an UUID that can be found in the users page by the organization administrator.
 | required |
| `x-organization-id` | query | OrganizationId, which identifies the organization to which perform the operation. 
This can be found in the organizations page by the organization administrator.
 | required |
| `authorization` | query | Bearer Access Token | required |

### POST /projects/{projectId}/branches/{branch}/publish/exchange

**Operation ID:** `createProjectsByProjectidBranchesByBranchPublishExchange`
Publish project to Exchange. As a result, an Exchange asset is created.

**Parameters:**
| `projectId` | query | Project unique ID | required |
| `branch` | query | Branch name to which apply a given operation | required |
| `x-owner-id` | query | User's ownerId, which identifies the user performing the operation. 
This is NOT the username, but an UUID that can be found in the users page by the organization administrator.
 | required |
| `x-organization-id` | query | OrganizationId, which identifies the organization to which perform the operation. 
This can be found in the organizations page by the organization administrator.
 | required |
| `authorization` | query | Bearer Access Token | required |

### POST /projects/{projectId}/branches/{branch}/exchange/dependencies

**Operation ID:** `createProjectsByProjectidBranchesByBranchExchangeDependencies`
Updates exchange.json file, with given dependencies

**Parameters:**
| `projectId` | query | Project unique ID | required |
| `branch` | query | Branch name to which apply a given operation | required |
| `x-owner-id` | query | User's ownerId, which identifies the user performing the operation. 
This is NOT the username, but an UUID that can be found in the users page by the organization administrator.
 | required |
| `x-organization-id` | query | OrganizationId, which identifies the organization to which perform the operation. 
This can be found in the organizations page by the organization administrator.
 | required |
| `authorization` | query | Bearer Access Token | required |

### PUT /projects/{projectId}/branches/{branch}/exchange/dependencies

**Operation ID:** `updateProjectsByProjectidBranchesByBranchExchangeDependencies`
Add new dependencies in exchange.json

**Parameters:**
| `projectId` | query | Project unique ID | required |
| `branch` | query | Branch name to which apply a given operation | required |
| `x-owner-id` | query | User's ownerId, which identifies the user performing the operation. 
This is NOT the username, but an UUID that can be found in the users page by the organization administrator.
 | required |
| `x-organization-id` | query | OrganizationId, which identifies the organization to which perform the operation. 
This can be found in the organizations page by the organization administrator.
 | required |
| `authorization` | query | Bearer Access Token | required |

### DELETE /projects/{projectId}/branches/{branch}/exchange/dependencies

**Operation ID:** `deleteProjectsByProjectidBranchesByBranchExchangeDependencies`
Removes dependencies in exchange.json

**Parameters:**
| `projectId` | query | Project unique ID | required |
| `branch` | query | Branch name to which apply a given operation | required |
| `x-owner-id` | query | User's ownerId, which identifies the user performing the operation. 
This is NOT the username, but an UUID that can be found in the users page by the organization administrator.
 | required |
| `x-organization-id` | query | OrganizationId, which identifies the organization to which perform the operation. 
This can be found in the organizations page by the organization administrator.
 | required |
| `authorization` | query | Bearer Access Token | required |

### GET /projects/{projectId}/api/{name}

**Operation ID:** `getProjectsByProjectidApiByName`
Get api data, from Api Platform, for given {name}

**Parameters:**
| `projectId` | query | Project unique ID | required |
| `name` | query | The name to identify the target resource. | required |

### POST /projects/{projectId}/api/{name}/{version}

**Operation ID:** `createProjectsByProjectidApiByNameByVersion`
Publish project to Api Platform (Deprecated)

**Parameters:**
| `projectId` | query | Project unique ID | required |
| `name` | query | The name to identify the target resource. | required |
| `version` | query | The version to identify the target resource. | required |

### POST /projects/{projectId}/sync/github

**Operation ID:** `createProjectsByProjectidSyncGithub`
Sync project with Github repository

**Parameters:**
| `projectId` | query | Project unique ID | required |

### DELETE /projects/{projectId}/sync/github

**Operation ID:** `deleteProjectsByProjectidSyncGithub`
Remove sync with Github repository

**Parameters:**
| `projectId` | query | Project unique ID | required |

### GET /projects/{projectId}/access/permissions

**Operation ID:** `getProjectsByProjectidAccessPermissions`
Gets permissions for a project

**Parameters:**
| `projectId` | query | Project unique ID | required |
| `x-owner-id` | query | User's ownerId, which identifies the user performing the operation. 
This is NOT the username, but an UUID that can be found in the users page by the organization administrator.
 | required |
| `x-organization-id` | query | OrganizationId, which identifies the organization to which perform the operation. 
This can be found in the organizations page by the organization administrator.
 | required |
| `authorization` | query | Bearer Access Token | required |

### POST /projects/{projectId}/access/permissions/share

**Operation ID:** `createProjectsByProjectidAccessPermissionsShare`
Grants or Revokes permissions on a [user | role] matrix for a project.

**Parameters:**
| `projectId` | query | Project unique ID | required |
| `x-owner-id` | query | User's ownerId, which identifies the user performing the operation. 
This is NOT the username, but an UUID that can be found in the users page by the organization administrator.
 | required |
| `x-organization-id` | query | OrganizationId, which identifies the organization to which perform the operation. 
This can be found in the organizations page by the organization administrator.
 | required |
| `authorization` | query | Bearer Access Token | required |

### POST /exchange/graphql

**Operation ID:** `createExchangeGraphql`
Executes GQL queries against exchange GraphQL service

**Parameters:**
| `authorization` | query | Bearer Access Token | required |