Documentation

UVCS CM API

UVCS CM API

Unity Version Control CM API

Overview

The Unity Version Control 
cm
API allows developers to perform Unity Version Control operations in their machine, provided that a Unity Version Control client is already installed and configured.
For more information about Unity Version Control, refer to our documentation.
Download OpenAPI specification:

Get branches

Retrieve the list of branches in a repository

Path parameters for "Get branches"

repName

string
required
The name of the repository

Query parameters for "Get branches"

q

string
Search query to filter branches

HTTP response status codes for "Get branches":

Code samples for "Get branches":

Request example

curl -X GET \ "http://localhost:9090/api/v1/repos/{repName}/branches"

Response example

[ { "name": "string", "id": 0, "parentId": 0, "lastChangeset": 0, "comment": "string", "creationDate": "2024-01-01T00:00:00Z", "guid": "string", "owner": { "name": "string", "isGroup": true }, "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" } }]

Create branch

Create a new branch in a repository

Path parameters for "Create branch"

repName

string
required
The name of the repository

Request body for "Create branch"

Media Type:
application/json

name

string
required
No description

origin

string
required
No description

originType

string
required
No description

comment

string
No description

topLevel

boolean
No description

HTTP response status codes for "Create branch":

Code samples for "Create branch":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "name": "string", "origin": "string", "originType": "string", "comment": "string", "topLevel": true}' \ "http://localhost:9090/api/v1/repos/{repName}/branches"

Response example

{ "name": "string", "id": 0, "parentId": 0, "lastChangeset": 0, "comment": "string", "creationDate": "2024-01-01T00:00:00Z", "guid": "string", "owner": { "name": "string", "isGroup": true }, "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" }}

Get branch changesets

Retrieve the list of changesets in a branch

Path parameters for "Get branch changesets"

repName

string
required
The name of the repository

branchName

string
required
The name of the branch

Query parameters for "Get branch changesets"

q

string
Search query to filter changesets

HTTP response status codes for "Get branch changesets":

Code samples for "Get branch changesets":

Request example

curl -X GET \ "http://localhost:9090/api/v1/repos/{repName}/branches/{branchName}/changesets"

Response example

[ { "id": 0, "parentId": 0, "comment": "string", "creationDate": "2024-01-01T00:00:00Z", "guid": "string", "branch": { "name": "string", "id": 0, "parentId": 0, "lastChangeset": 0, "comment": "string", "creationDate": "2024-01-01T00:00:00Z", "guid": "string", "owner": { "name": "string", "isGroup": true }, "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" } }, "owner": { "name": "string", "isGroup": true }, "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" } }]

Get branch diff

Retrieve the differences of a branch

Path parameters for "Get branch diff"

repName

string
required
The name of the repository

branchName

string
required
The name of the branch

HTTP response status codes for "Get branch diff":

Code samples for "Get branch diff":

Request example

curl -X GET \ "http://localhost:9090/api/v1/repos/{repName}/branches/{branchName}/diff"

Response example

[ { "status": "added", "path": "string", "srcPath": "string", "revisionId": 0, "srcRevisionId": 0, "isDirectory": true, "size": 0, "hash": "string", "srcHash": "string", "isUnderXlink": true, "xlink": { "changesetGuid": "string", "changesetId": 0, "repository": "string", "server": "string" }, "baseXlink": { "changesetGuid": "string", "changesetId": 0, "repository": "string", "server": "string" }, "merges": [ { "mergeType": "string", "sourceChangeset": { "id": 0, "parentId": 0, "comment": "string", "creationDate": "2024-01-01T00:00:00Z", "guid": "string", "branch": { "name": null, "id": null, "parentId": null, "lastChangeset": null, "comment": null, "creationDate": null, "guid": null, "owner": null, "repository": null }, "owner": { "name": null, "isGroup": null }, "repository": { "name": null, "repId": null, "guid": null, "owner": null, "server": null } } } ], "isItemFSProtectionChanged": true, "itemFileSystemProtection": "string", "baseItemFileSystemProtection": "string", "modifiedTime": "2024-01-01T00:00:00Z", "createdBy": { "name": "string", "isGroup": true }, "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" } }]

Get branch contents

Retrieve the contents of a branch

Path parameters for "Get branch contents"

repName

string
required
The name of the repository

branchName

string
required
The name of the branch

path

string
required
The path to the file or directory

HTTP response status codes for "Get branch contents":

Code samples for "Get branch contents":

Request example

curl -X GET \ "http://localhost:9090/api/v1/repos/{repName}/branches/{branchName}/contents/{path}"

Response example

{ "revisionId": 0, "type": "string", "size": 0, "name": "string", "path": "string", "changeset": 0, "branch": "string", "isUnderXlink": true, "xlinkTarget": { "changesetGuid": "string", "changesetId": 0, "repository": "string", "server": "string" }, "hash": "string", "content": "string", "items": [ { "revisionId": 0, "type": "string", "size": 0, "name": "string", "path": "string", "changeset": 0, "branch": "string", "isUnderXlink": true, "xlinkTarget": { "changesetGuid": "string", "changesetId": 0, "repository": "string", "server": "string" }, "hash": "string", "content": "string", "items": [ { "revisionId": 0, "type": "string", "size": 0, "name": "string", "path": "string", "changeset": 0, "branch": "string", "isUnderXlink": true, "xlinkTarget": { "changesetGuid": null, "changesetId": null, "repository": null, "server": null }, "hash": "string", "content": "string", "items": [ null ], "repository": { "name": null, "repId": null, "guid": null, "owner": null, "server": null } } ], "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" } } ], "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" }}

Get branch item contents

Retrieve the contents of an item in a branch

Path parameters for "Get branch item contents"

repName

string
required
The name of the repository

branchName

string
required
The name of the branch

Query parameters for "Get branch item contents"

item

string
The absolute path of the item (file or directory)

HTTP response status codes for "Get branch item contents":

Code samples for "Get branch item contents":

Request example

curl -X GET \ "http://localhost:9090/api/v1/repos/{repName}/branches/{branchName}/contents"

Response example

{ "revisionId": 0, "type": "string", "size": 0, "name": "string", "path": "string", "changeset": 0, "branch": "string", "isUnderXlink": true, "xlinkTarget": { "changesetGuid": "string", "changesetId": 0, "repository": "string", "server": "string" }, "hash": "string", "content": "string", "items": [ { "revisionId": 0, "type": "string", "size": 0, "name": "string", "path": "string", "changeset": 0, "branch": "string", "isUnderXlink": true, "xlinkTarget": { "changesetGuid": "string", "changesetId": 0, "repository": "string", "server": "string" }, "hash": "string", "content": "string", "items": [ { "revisionId": 0, "type": "string", "size": 0, "name": "string", "path": "string", "changeset": 0, "branch": "string", "isUnderXlink": true, "xlinkTarget": { "changesetGuid": null, "changesetId": null, "repository": null, "server": null }, "hash": "string", "content": "string", "items": [ null ], "repository": { "name": null, "repId": null, "guid": null, "owner": null, "server": null } } ], "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" } } ], "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" }}

Get branch item history

Retrieve the history of an item in a branch

Path parameters for "Get branch item history"

repName

string
required
The name of the repository

branchName

string
required
The name of the branch

Query parameters for "Get branch item history"

item

string
The absolute path of the item (file or directory)

HTTP response status codes for "Get branch item history":

Code samples for "Get branch item history":

Request example

curl -X GET \ "http://localhost:9090/api/v1/repos/{repName}/branches/{branchName}/history"

Response example

[ { "revisionId": 0, "type": "string", "owner": { "name": "string", "isGroup": true }, "creationDate": "2024-01-01T00:00:00Z", "comment": "string", "revisionLink": "string", "changesetId": 0, "changesetLink": "string", "branchName": "string", "branchLink": "string", "repositoryName": "string", "repositoryLink": "string" }]

Get branch history

Retrieve the history of a branch

Path parameters for "Get branch history"

repName

string
required
The name of the repository

branchName

string
required
The name of the branch

path

string
required
The absolute path of the item (file or directory)

HTTP response status codes for "Get branch history":

Code samples for "Get branch history":

Request example

curl -X GET \ "http://localhost:9090/api/v1/repos/{repName}/branches/{branchName}/history/{path}"

Response example

[ { "revisionId": 0, "type": "string", "owner": { "name": "string", "isGroup": true }, "creationDate": "2024-01-01T00:00:00Z", "comment": "string", "revisionLink": "string", "changesetId": 0, "changesetLink": "string", "branchName": "string", "branchLink": "string", "repositoryName": "string", "repositoryLink": "string" }]

Get branch information

Retrieve the information of a branch

Path parameters for "Get branch information"

repName

string
required
The name of the repository

branchName

string
required
The name of the branch

HTTP response status codes for "Get branch information":

Code samples for "Get branch information":

Request example

curl -X GET \ "http://localhost:9090/api/v1/repos/{repName}/branches/{branchName}"

Response example

{ "name": "string", "id": 0, "parentId": 0, "lastChangeset": 0, "comment": "string", "creationDate": "2024-01-01T00:00:00Z", "guid": "string", "owner": { "name": "string", "isGroup": true }, "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" }}

Update branch

Update the information of a branch

Path parameters for "Update branch"

repName

string
required
No description

branchName

string
required
No description

Request body for "Update branch"

Media Type:
application/json

name

string
required
The name of the branch

id

integer
The numeric ID of the branch

parentId

integer
The numeric ID of the parent branch

lastChangeset

integer
The ID of the last changeset

comment

string
The comment associated with the branch

creationDate

string
The date and time when the branch was created

guid

string
The globally unique identifier for the branch

owner

object
The owner of a repository or repository object

name

string
The name of the owner

isGroup

boolean
Indicates if the owner is a group

repository

object
A repository in a Unity Version Control server

name

string
required
The name of the repository

repId

object
The ID of a repository

id

integer
The ID of the repository

deprecatedModuleId

integer
[Deprecated] The module ID, if the repository is a submodule

guid

string
The globally unique identifier for the repository

owner

object
The owner of a repository or repository object

name

string
The name of the owner

isGroup

boolean
Indicates if the owner is a group

server

string
The server hosting the repository

HTTP response status codes for "Update branch":

Code samples for "Update branch":

Request example

curl -X PATCH \ -H "Content-Type: application/json" \ -d '{ "name": "string", "id": 0, "parentId": 0, "lastChangeset": 0, "comment": "string", "creationDate": "2024-01-01T00:00:00Z", "guid": "string", "owner": { "name": "string", "isGroup": true }, "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" }}' \ "http://localhost:9090/api/v1/repos/{repName}/branches/{branchName}"

Response example

{ "name": "string", "id": 0, "parentId": 0, "lastChangeset": 0, "comment": "string", "creationDate": "2024-01-01T00:00:00Z", "guid": "string", "owner": { "name": "string", "isGroup": true }, "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" }}

Delete branch

Delete a branch

Path parameters for "Delete branch"

repName

string
required
The name of the repository

branchName

string
required
The name of the branch

HTTP response status codes for "Delete branch":

Code samples for "Delete branch":

Request example

curl -X DELETE \ "http://localhost:9090/api/v1/repos/{repName}/branches/{branchName}"

Response example

Get pending changes

Retrieve a list of pending changes in a workspace

Path parameters for "Get pending changes"

wkName

string
required
The name of the workspace

Query parameters for "Get pending changes"

types

string
Comma-separated list of change types to filter by. Example: 
types=added,changed,deleted

HTTP response status codes for "Get pending changes":

Code samples for "Get pending changes":

Request example

curl -X GET \ "http://localhost:9090/api/v1/wkspaces/{wkName}/changes"

Response example

[ { "changes": [ "added" ], "path": "string", "oldPath": "string", "serverPath": "string", "oldServerPath": "string", "isXlink": true, "xlinkMount": { "name": "string", "mountPoint": "string", "guid": "string", "isWritable": true, "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" } }, "localInfo": { "modifiedTime": "2024-01-01T00:00:00Z", "size": 0, "isMissing": true }, "revisionInfo": { "id": 0, "parentId": 0, "itemId": 0, "type": "string", "size": 0, "hash": "string", "branchId": 0, "changesetId": 0, "isCheckedOut": true, "creationDate": "2024-01-01T00:00:00Z", "repositoryId": { "id": 0, "deprecatedModuleId": 0 }, "owner": { "name": "string", "isGroup": true } } }]

Undo pending changes

Undo a list of pending changes in a workspace

Path parameters for "Undo pending changes"

wkName

string
required
The name of the workspace

Request body for "Undo pending changes"

Media Type:
application/json

paths

array[string]
No description

HTTP response status codes for "Undo pending changes":

Code samples for "Undo pending changes":

Request example

curl -X DELETE \ -H "Content-Type: application/json" \ -d '{ "paths": [ "string" ]}' \ "http://localhost:9090/api/v1/wkspaces/{wkName}/changes"

Response example

{ "affectedPaths": [ "string" ]}

Get changesets

Retrieve a list of changesets in a repository

Path parameters for "Get changesets"

repName

string
required
The name of the repository

Query parameters for "Get changesets"

q

string
Query string to filter changesets

HTTP response status codes for "Get changesets":

Code samples for "Get changesets":

Request example

curl -X GET \ "http://localhost:9090/api/v1/repos/{repName}/changesets"

Response example

[ { "id": 0, "parentId": 0, "comment": "string", "creationDate": "2024-01-01T00:00:00Z", "guid": "string", "branch": { "name": "string", "id": 0, "parentId": 0, "lastChangeset": 0, "comment": "string", "creationDate": "2024-01-01T00:00:00Z", "guid": "string", "owner": { "name": "string", "isGroup": true }, "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" } }, "owner": { "name": "string", "isGroup": true }, "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" } }]

Get changeset

Retrieve a specific changeset in a repository

Path parameters for "Get changeset"

repName

string
required
The name of the repository

changesetId

integer
required
The ID of the changeset

HTTP response status codes for "Get changeset":

Code samples for "Get changeset":

Request example

curl -X GET \ "http://localhost:9090/api/v1/repos/{repName}/changesets/{changesetId}"

Response example

{ "id": 0, "parentId": 0, "comment": "string", "creationDate": "2024-01-01T00:00:00Z", "guid": "string", "branch": { "name": "string", "id": 0, "parentId": 0, "lastChangeset": 0, "comment": "string", "creationDate": "2024-01-01T00:00:00Z", "guid": "string", "owner": { "name": "string", "isGroup": true }, "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" } }, "owner": { "name": "string", "isGroup": true }, "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" }}

Get revision in changeset

Retrieve the revision of a specific item in a changeset in a repository

Path parameters for "Get revision in changeset"

repName

string
required
The name of the repository

changesetId

integer
required
The ID of the changeset

path

string
required
The absolute path of the item in the changeset

HTTP response status codes for "Get revision in changeset":

Code samples for "Get revision in changeset":

Request example

curl -X GET \ "http://localhost:9090/api/v1/repos/{repName}/changesets/{changesetId}/contents/{path}"

Response example

{ "revisionId": 0, "type": "string", "size": 0, "name": "string", "path": "string", "changeset": 0, "branch": "string", "isUnderXlink": true, "xlinkTarget": { "changesetGuid": "string", "changesetId": 0, "repository": "string", "server": "string" }, "hash": "string", "content": "string", "items": [ { "revisionId": 0, "type": "string", "size": 0, "name": "string", "path": "string", "changeset": 0, "branch": "string", "isUnderXlink": true, "xlinkTarget": { "changesetGuid": "string", "changesetId": 0, "repository": "string", "server": "string" }, "hash": "string", "content": "string", "items": [ { "revisionId": 0, "type": "string", "size": 0, "name": "string", "path": "string", "changeset": 0, "branch": "string", "isUnderXlink": true, "xlinkTarget": { "changesetGuid": null, "changesetId": null, "repository": null, "server": null }, "hash": "string", "content": "string", "items": [ null ], "repository": { "name": null, "repId": null, "guid": null, "owner": null, "server": null } } ], "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" } } ], "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" }}

Get item history in changeset

Retrieve the history of a specific item in a changeset in a repository

Path parameters for "Get item history in changeset"

repName

string
required
The name of the repository

changesetId

integer
required
The ID of the changeset

path

string
required
The absolute path of the item in the changeset

HTTP response status codes for "Get item history in changeset":

Code samples for "Get item history in changeset":

Request example

curl -X GET \ "http://localhost:9090/api/v1/repos/{repName}/changesets/{changesetId}/history/{path}"

Response example

[ { "revisionId": 0, "type": "string", "owner": { "name": "string", "isGroup": true }, "creationDate": "2024-01-01T00:00:00Z", "comment": "string", "revisionLink": "string", "changesetId": 0, "changesetLink": "string", "branchName": "string", "branchLink": "string", "repositoryName": "string", "repositoryLink": "string" }]

Get changeset diff

Retrieve the differences introduced in a specific changeset in a repository

Path parameters for "Get changeset diff"

repName

string
required
The name of the repository

changesetId

integer
required
The ID of the changeset

HTTP response status codes for "Get changeset diff":

Code samples for "Get changeset diff":

Request example

curl -X GET \ "http://localhost:9090/api/v1/repos/{repName}/changesets/{changesetId}/diff"

Response example

[ { "status": "added", "path": "string", "srcPath": "string", "revisionId": 0, "srcRevisionId": 0, "isDirectory": true, "size": 0, "hash": "string", "srcHash": "string", "isUnderXlink": true, "xlink": { "changesetGuid": "string", "changesetId": 0, "repository": "string", "server": "string" }, "baseXlink": { "changesetGuid": "string", "changesetId": 0, "repository": "string", "server": "string" }, "merges": [ { "mergeType": "string", "sourceChangeset": { "id": 0, "parentId": 0, "comment": "string", "creationDate": "2024-01-01T00:00:00Z", "guid": "string", "branch": { "name": null, "id": null, "parentId": null, "lastChangeset": null, "comment": null, "creationDate": null, "guid": null, "owner": null, "repository": null }, "owner": { "name": null, "isGroup": null }, "repository": { "name": null, "repId": null, "guid": null, "owner": null, "server": null } } } ], "isItemFSProtectionChanged": true, "itemFileSystemProtection": "string", "baseItemFileSystemProtection": "string", "modifiedTime": "2024-01-01T00:00:00Z", "createdBy": { "name": "string", "isGroup": true }, "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" } }]

Get changeset diff with another changeset

Retrieve the differences introduced in a specific changeset in a repository compared to another changeset

Path parameters for "Get changeset diff with another changeset"

repName

string
required
The name of the repository

dstCsetId

integer
required
The ID of the destination changeset

srcCsetId

integer
required
The ID of the source changeset

HTTP response status codes for "Get changeset diff with another changeset":

Code samples for "Get changeset diff with another changeset":

Request example

curl -X GET \ "http://localhost:9090/api/v1/repos/{repName}/changesets/{dstCsetId}/diff/{srcCsetId}"

Response example

[ { "status": "added", "path": "string", "srcPath": "string", "revisionId": 0, "srcRevisionId": 0, "isDirectory": true, "size": 0, "hash": "string", "srcHash": "string", "isUnderXlink": true, "xlink": { "changesetGuid": "string", "changesetId": 0, "repository": "string", "server": "string" }, "baseXlink": { "changesetGuid": "string", "changesetId": 0, "repository": "string", "server": "string" }, "merges": [ { "mergeType": "string", "sourceChangeset": { "id": 0, "parentId": 0, "comment": "string", "creationDate": "2024-01-01T00:00:00Z", "guid": "string", "branch": { "name": null, "id": null, "parentId": null, "lastChangeset": null, "comment": null, "creationDate": null, "guid": null, "owner": null, "repository": null }, "owner": { "name": null, "isGroup": null }, "repository": { "name": null, "repId": null, "guid": null, "owner": null, "server": null } } } ], "isItemFSProtectionChanged": true, "itemFileSystemProtection": "string", "baseItemFileSystemProtection": "string", "modifiedTime": "2024-01-01T00:00:00Z", "createdBy": { "name": "string", "isGroup": true }, "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" } }]

Get check-in status

Retrieve the current check-in status for a workspace.

Path parameters for "Get check-in status"

wkName

string
required
The name of the workspace.

HTTP response status codes for "Get check-in status":

Code samples for "Get check-in status":

Request example

curl -X GET \ "http://localhost:9090/api/v1/wkspaces/{wkName}/checkin"

Response example

{ "status": "string", "message": "string"}

Perform check-in

Check in changes to the workspace.

Path parameters for "Perform check-in"

wkName

string
required
The name of the workspace.

Request body for "Perform check-in"

Media Type:
application/json

paths

array[string]
No description

comment

string
No description

recurse

boolean
No description

HTTP response status codes for "Perform check-in":

Code samples for "Perform check-in":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "paths": [ "string" ], "comment": "string", "recurse": true}' \ "http://localhost:9090/api/v1/wkspaces/{wkName}/checkin"

Response example

{ "status": "string", "message": "string"}

Create a shelveset

Create a new shelveset in the specified workspace.

Path parameters for "Create a shelveset"

wkName

string
required
The name of the workspace.

Request body for "Create a shelveset"

Media Type:
application/json

comment

string
No description

paths

array[string]
No description

HTTP response status codes for "Create a shelveset":

Code samples for "Create a shelveset":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "comment": "string", "paths": [ "string" ]}' \ "http://localhost:9090/api/v1/wkspaces/{wkName}/shelvesets"

Response example

{ "status": "string", "message": "string"}

Get file information

Retrieve detailed information about a specific file in the workspace.

Path parameters for "Get file information"

wkName

string
required
The name of the workspace.

path

string
required
The path to the file within the workspace.

HTTP response status codes for "Get file information":

Code samples for "Get file information":

Request example

curl -X GET \ "http://localhost:9090/api/v1/wkspaces/{wkName}/fileinfo/{path}"

Response example

{ "clientPath": "string", "relativePath": "string", "serverPath": "string", "repSpec": { "server": "string", "name": "string" }, "size": 0, "hash": "string", "owner": "string", "revisionHeadChangeset": 0, "revisionChangeset": 0, "status": "string", "type": "string", "changelist": "string", "locked": { "lockedBy": "string", "lockedWhere": "string" }, "underXlink": { "underXlinkWritable": true, "underXlinkRelative": true, "underXlinkTarget": "string", "underXlinkPath": "string" }, "xlink": { "xlinkWritable": true, "xlinkRelative": true, "xlinkTarget": "string", "xlinkName": "string" }}

Get labels

Retrieve a list of labels for the specified repository.

Path parameters for "Get labels"

repName

string
required
The name of the repository.

Query parameters for "Get labels"

q

string
The search query for filtering labels.

HTTP response status codes for "Get labels":

Code samples for "Get labels":

Request example

curl -X GET \ "http://localhost:9090/api/v1/repos/{repName}/labels"

Response example

[ { "name": "string", "id": 0, "changeset": 0, "comment": "string", "creationDate": "2024-01-01T00:00:00Z", "branch": { "name": "string", "id": 0, "parentId": 0, "lastChangeset": 0, "comment": "string", "creationDate": "2024-01-01T00:00:00Z", "guid": "string", "owner": { "name": "string", "isGroup": true }, "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" } }, "owner": { "name": "string", "isGroup": true }, "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" } }]

Create a new label

Create a new label for the specified repository.

Path parameters for "Create a new label"

repName

string
required
The name of the repository.

Request body for "Create a new label"

Media Type:
application/json

name

string
required
No description

changeset

integer
required
No description

comment

string
No description

applyToXlinks

boolean
No description

HTTP response status codes for "Create a new label":

Code samples for "Create a new label":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "name": "string", "changeset": 0, "comment": "string", "applyToXlinks": true}' \ "http://localhost:9090/api/v1/repos/{repName}/labels"

Response example

{ "name": "string", "id": 0, "changeset": 0, "comment": "string", "creationDate": "2024-01-01T00:00:00Z", "branch": { "name": "string", "id": 0, "parentId": 0, "lastChangeset": 0, "comment": "string", "creationDate": "2024-01-01T00:00:00Z", "guid": "string", "owner": { "name": "string", "isGroup": true }, "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" } }, "owner": { "name": "string", "isGroup": true }, "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" }}

Get a label

Retrieve detailed information about a specific label in the repository.

Path parameters for "Get a label"

repName

string
required
The name of the repository.

labelName

string
required
The name of the label.

HTTP response status codes for "Get a label":

Code samples for "Get a label":

Request example

curl -X GET \ "http://localhost:9090/api/v1/repos/{repName}/labels/{labelName}"

Response example

{ "name": "string", "id": 0, "changeset": 0, "comment": "string", "creationDate": "2024-01-01T00:00:00Z", "branch": { "name": "string", "id": 0, "parentId": 0, "lastChangeset": 0, "comment": "string", "creationDate": "2024-01-01T00:00:00Z", "guid": "string", "owner": { "name": "string", "isGroup": true }, "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" } }, "owner": { "name": "string", "isGroup": true }, "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" }}

Update a label

Update an existing label in the specified repository.

Path parameters for "Update a label"

repName

string
required
The name of the repository.

labelName

string
required
The name of the label.

Request body for "Update a label"

Media Type:
application/json

name

string
required
No description

id

integer
No description

changeset

integer
No description

comment

string
No description

creationDate

string
No description

branch

object
No description

name

string
required
The name of the branch

id

integer
The numeric ID of the branch

parentId

integer
The numeric ID of the parent branch

lastChangeset

integer
The ID of the last changeset

comment

string
The comment associated with the branch

creationDate

string
The date and time when the branch was created

guid

string
The globally unique identifier for the branch

owner

object
The owner of a repository or repository object

name

string
The name of the owner

isGroup

boolean
Indicates if the owner is a group

repository

object
A repository in a Unity Version Control server

name

string
required
The name of the repository

repId

object
The ID of a repository

id

integer
The ID of the repository

deprecatedModuleId

integer
[Deprecated] The module ID, if the repository is a submodule

guid

string
The globally unique identifier for the repository

owner

object
The owner of a repository or repository object

name

string
The name of the owner

isGroup

boolean
Indicates if the owner is a group

server

string
The server hosting the repository

owner

object
The owner of a repository or repository object

name

string
The name of the owner

isGroup

boolean
Indicates if the owner is a group

repository

object
A repository in a Unity Version Control server

name

string
required
The name of the repository

repId

object
The ID of a repository

id

integer
The ID of the repository

deprecatedModuleId

integer
[Deprecated] The module ID, if the repository is a submodule

guid

string
The globally unique identifier for the repository

owner

object
The owner of a repository or repository object

name

string
The name of the owner

isGroup

boolean
Indicates if the owner is a group

server

string
The server hosting the repository

HTTP response status codes for "Update a label":

Code samples for "Update a label":

Request example

curl -X PATCH \ -H "Content-Type: application/json" \ -d '{ "name": "string", "id": 0, "changeset": 0, "comment": "string", "creationDate": "2024-01-01T00:00:00Z", "branch": { "name": "string", "id": 0, "parentId": 0, "lastChangeset": 0, "comment": "string", "creationDate": "2024-01-01T00:00:00Z", "guid": "string", "owner": { "name": "string", "isGroup": true }, "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" } }, "owner": { "name": "string", "isGroup": true }, "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" }}' \ "http://localhost:9090/api/v1/repos/{repName}/labels/{labelName}"

Response example

{ "name": "string", "id": 0, "changeset": 0, "comment": "string", "creationDate": "2024-01-01T00:00:00Z", "branch": { "name": "string", "id": 0, "parentId": 0, "lastChangeset": 0, "comment": "string", "creationDate": "2024-01-01T00:00:00Z", "guid": "string", "owner": { "name": "string", "isGroup": true }, "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" } }, "owner": { "name": "string", "isGroup": true }, "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" }}

Delete a label

Delete a specific label from the repository.

Path parameters for "Delete a label"

repName

string
required
The name of the repository.

labelName

string
required
The name of the label.

HTTP response status codes for "Delete a label":

Code samples for "Delete a label":

Request example

curl -X DELETE \ "http://localhost:9090/api/v1/repos/{repName}/labels/{labelName}"

Response example

Get a specific revision in a label

Retrieve a specific revision of an item in a label.

Path parameters for "Get a specific revision in a label"

repName

string
required
The name of the repository.

labelName

string
required
The name of the label.

path

string
required
The absolute path to the item within the label.

HTTP response status codes for "Get a specific revision in a label":

Code samples for "Get a specific revision in a label":

Request example

curl -X GET \ "http://localhost:9090/api/v1/repos/{repName}/labels/{labelName}/contents/{path}"

Response example

{ "revisionId": 0, "type": "string", "size": 0, "name": "string", "path": "string", "changeset": 0, "branch": "string", "isUnderXlink": true, "xlinkTarget": { "changesetGuid": "string", "changesetId": 0, "repository": "string", "server": "string" }, "hash": "string", "content": "string", "items": [ { "revisionId": 0, "type": "string", "size": 0, "name": "string", "path": "string", "changeset": 0, "branch": "string", "isUnderXlink": true, "xlinkTarget": { "changesetGuid": "string", "changesetId": 0, "repository": "string", "server": "string" }, "hash": "string", "content": "string", "items": [ { "revisionId": 0, "type": "string", "size": 0, "name": "string", "path": "string", "changeset": 0, "branch": "string", "isUnderXlink": true, "xlinkTarget": { "changesetGuid": null, "changesetId": null, "repository": null, "server": null }, "hash": "string", "content": "string", "items": [ null ], "repository": { "name": null, "repId": null, "guid": null, "owner": null, "server": null } } ], "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" } } ], "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" }}

Get the revision history of a specific item in a label

Retrieve the revision history of an item in a label.

Path parameters for "Get the revision history of a specific item in a label"

repName

string
required
The name of the repository.

labelName

string
required
The name of the label.

path

string
required
The absolute path to the item within the label.

HTTP response status codes for "Get the revision history of a specific item in a label":

Code samples for "Get the revision history of a specific item in a label":

Request example

curl -X GET \ "http://localhost:9090/api/v1/repos/{repName}/labels/{labelName}/history/{path}"

Response example

[ { "revisionId": 0, "type": "string", "owner": { "name": "string", "isGroup": true }, "creationDate": "2024-01-01T00:00:00Z", "comment": "string", "revisionLink": "string", "changesetId": 0, "changesetLink": "string", "branchName": "string", "branchLink": "string", "repositoryName": "string", "repositoryLink": "string" }]

Get a list of repositories

Retrieve a list of all repositories.

HTTP response status codes for "Get a list of repositories":

Code samples for "Get a list of repositories":

Request example

curl -X GET \ "http://localhost:9090/api/v1/repos"

Response example

[ { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" }]

Create a new repository

This endpoint allows you to create a new repository.

Request body for "Create a new repository"

Media Type:
application/json

name

string
required
No description

server

string
No description

HTTP response status codes for "Create a new repository":

Code samples for "Create a new repository":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "name": "string", "server": "string"}' \ "http://localhost:9090/api/v1/repos"

Response example

{ "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string"}

Get a specific repository

Retrieve a specific repository by name.

Path parameters for "Get a specific repository"

repName

string
required
The name of the repository.

HTTP response status codes for "Get a specific repository":

Code samples for "Get a specific repository":

Request example

curl -X GET \ "http://localhost:9090/api/v1/repos/{repName}"

Response example

{ "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string"}

Delete a specific repository

This endpoint allows you to delete a specific repository by name.

Path parameters for "Delete a specific repository"

repName

string
required
The name of the repository.

HTTP response status codes for "Delete a specific repository":

Code samples for "Delete a specific repository":

Request example

curl -X DELETE \ "http://localhost:9090/api/v1/repos/{repName}"

Response example

Update a specific repository

This endpoint allows you to update a specific repository by name.

Path parameters for "Update a specific repository"

repName

string
required
The name of the repository.

Request body for "Update a specific repository"

Media Type:
application/json

name

string
required
The name of the repository

repId

object
The ID of a repository

id

integer
The ID of the repository

deprecatedModuleId

integer
[Deprecated] The module ID, if the repository is a submodule

guid

string
The globally unique identifier for the repository

owner

object
The owner of a repository or repository object

name

string
The name of the owner

isGroup

boolean
Indicates if the owner is a group

server

string
The server hosting the repository

HTTP response status codes for "Update a specific repository":

Code samples for "Update a specific repository":

Request example

curl -X PUT \ -H "Content-Type: application/json" \ -d '{ "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string"}' \ "http://localhost:9090/api/v1/repos/{repName}"

Response example

{ "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string"}

Revert an item to a previous revision

This endpoint allows you to revert an item in a workspace to a previous revision.

Path parameters for "Revert an item to a previous revision"

wkName

string
required
The name of the workspace

path

string
required
The path of the item to revert

Request body for "Revert an item to a previous revision"

Media Type:
application/json

changeset

integer
required
No description

HTTP response status codes for "Revert an item to a previous revision":

Code samples for "Revert an item to a previous revision":

Request example

curl -X PUT \ -H "Content-Type: application/json" \ -d '{ "changeset": 0}' \ "http://localhost:9090/api/v1/wkspaces/{wkName}/revert/{path}"

Response example

{ "affectedPaths": [ "string" ]}

Get a specific revision

This endpoint retrieves a specific revision of a repository.

Path parameters for "Get a specific revision"

repName

string
required
The name of the repository

revId

integer
required
The ID of the revision

HTTP response status codes for "Get a specific revision":

Code samples for "Get a specific revision":

Request example

curl -X GET \ "http://localhost:9090/api/v1/repos/{repName}/revisions/{revId}"

Response example

{ "revisionId": 0, "type": "string", "size": 0, "name": "string", "path": "string", "changeset": 0, "branch": "string", "isUnderXlink": true, "xlinkTarget": { "changesetGuid": "string", "changesetId": 0, "repository": "string", "server": "string" }, "hash": "string", "content": "string", "items": [ { "revisionId": 0, "type": "string", "size": 0, "name": "string", "path": "string", "changeset": 0, "branch": "string", "isUnderXlink": true, "xlinkTarget": { "changesetGuid": "string", "changesetId": 0, "repository": "string", "server": "string" }, "hash": "string", "content": "string", "items": [ { "revisionId": 0, "type": "string", "size": 0, "name": "string", "path": "string", "changeset": 0, "branch": "string", "isUnderXlink": true, "xlinkTarget": { "changesetGuid": null, "changesetId": null, "repository": null, "server": null }, "hash": "string", "content": "string", "items": [ null ], "repository": { "name": null, "repId": null, "guid": null, "owner": null, "server": null } } ], "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" } } ], "repository": { "name": "string", "repId": { "id": 0, "deprecatedModuleId": 0 }, "guid": "string", "owner": { "name": "string", "isGroup": true }, "server": "string" }}

Get the raw data of a specific revision

This endpoint retrieves the raw data (blob) of a specific revision in a repository.

Path parameters for "Get the raw data of a specific revision"

repName

string
required
The name of the repository

revId

integer
required
The ID of the revision

HTTP response status codes for "Get the raw data of a specific revision":

Code samples for "Get the raw data of a specific revision":

Request example

curl -X GET \ "http://localhost:9090/api/v1/repos/{repName}/revisions/{revId}/blob"

Response example

Undelete a workspace item

This endpoint restores a previously deleted item in a workspace.

Path parameters for "Undelete a workspace item"

wkName

string
required
The name of the workspace

Request body for "Undelete a workspace item"

Media Type:
application/json

revSpec

string
required
No description

path

string
required
No description

HTTP response status codes for "Undelete a workspace item":

Code samples for "Undelete a workspace item":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "revSpec": "string", "path": "string"}' \ "http://localhost:9090/api/v1/wkspaces/{wkName}/undelete"

Response example

{ "affectedPaths": [ "string" ]}

Get workspace switch status

This endpoint retrieves the current switch status of a workspace.

Path parameters for "Get workspace switch status"

wkName

string
required
The name of the workspace

HTTP response status codes for "Get workspace switch status":

Code samples for "Get workspace switch status":

Request example

curl -X GET \ "http://localhost:9090/api/v1/wkspaces/{wkName}/switch"

Response example

{ "status": "string", "message": "string"}

Switch workspace

This endpoint allows the user to switch a workspace to a different target (branch, label, changeset, or shelveset).

Path parameters for "Switch workspace"

wkName

string
required
The name of the workspace

Request body for "Switch workspace"

Media Type:
application/json

objectType

string
required
No description

object

string
required
No description

HTTP response status codes for "Switch workspace":

Code samples for "Switch workspace":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "objectType": "string", "object": "string"}' \ "http://localhost:9090/api/v1/wkspaces/{wkName}/switch"

Response example

{ "status": "string", "message": "string"}

Get workspace update status

This endpoint retrieves the current update status of a workspace.

Path parameters for "Get workspace update status"

wkName

string
required
The name of the workspace

HTTP response status codes for "Get workspace update status":

Code samples for "Get workspace update status":

Request example

curl -X GET \ "http://localhost:9090/api/v1/wkspaces/{wkName}/update"

Response example

{ "status": "string", "message": "string"}

Update workspace

This endpoint allows the user to update the workspace.

Path parameters for "Update workspace"

wkName

string
required
The name of the workspace

HTTP response status codes for "Update workspace":

Code samples for "Update workspace":

Request example

curl -X POST \ "http://localhost:9090/api/v1/wkspaces/{wkName}/update"

Response example

{ "status": "string", "message": "string"}

Partially configure workspace

This endpoint allows the user to partially configure (Gluon) the workspace.

Path parameters for "Partially configure workspace"

wkName

string
required
The name of the workspace

Request body for "Partially configure workspace"

Media Type:
application/json

instructions

array[object]
required
No description

path

string
required
No description

action

string
required
No description

HTTP response status codes for "Partially configure workspace":

Code samples for "Partially configure workspace":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "instructions": [ { "path": "string", "action": "Load" } ]}' \ "http://localhost:9090/api/v1/wkspaces/{wkName}/partialconfigure"

Response example

{ "status": "string", "message": "string"}

Merge changes from another object

This endpoint allows the user to merge changes from another branch or changeset into the current workspace.

Path parameters for "Merge changes from another object"

wkName

string
required
The name of the workspace

Request body for "Merge changes from another object"

Media Type:
application/json

sourceSpec

string
required
No description

HTTP response status codes for "Merge changes from another object":

Code samples for "Merge changes from another object":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "sourceSpec": "string"}' \ "http://localhost:9090/api/v1/wkspaces/{wkName}/merge"

Response example

{ "resultStatus": "AncestorCalculated", "success": true, "status": "string", "message": "string"}

Apply a shelveset

Apply a shelveset to the workspace

Path parameters for "Apply a shelveset"

wkName

string
required
The name of the workspace

shelvesetId

integer
required
The ID of the shelveset to apply

HTTP response status codes for "Apply a shelveset":

Code samples for "Apply a shelveset":

Request example

curl -X PATCH \ "http://localhost:9090/api/v1/wkspaces/{wkName}/shelvesets/{shelvesetId}"

Response example

{ "conflicts": [ "string" ]}

Add item to version control

Mark a private or ignored item for inclusion in version control

Path parameters for "Add item to version control"

wkName

string
required
The name of the workspace

path

string
required
The path of the item to add, relative to the workspace

Request body for "Add item to version control"

Media Type:
application/json

recurse

boolean
Add items recursively if the targeted item is a directory.

addPrivateParents

boolean
Ensure all parents are added if the targeted item is not located in a path that is under version control.

checkoutParent

boolean
Perform a checkout of the containing parent for the targeted item.

ignoreFailed

boolean
Skip failures from items that couldn't be added, so that the operation doesn't fail because of that.

HTTP response status codes for "Add item to version control":

Code samples for "Add item to version control":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "recurse": true, "addPrivateParents": true, "checkoutParent": true, "ignoreFailed": true}' \ "http://localhost:9090/api/v1/wkspaces/{wkName}/content/{path}"

Response example

{ "affectedPaths": [ "string" ]}

Checkout item in version control

Checkout a specific item in the workspace. This operation marks the item as checked out and prepares it for editing. It can also cause the item to be locked, depending on the server configuration.

Path parameters for "Checkout item in version control"

wkName

string
required
The name of the workspace

path

string
required
The path of the item to checkout, relative to the workspace

HTTP response status codes for "Checkout item in version control":

Code samples for "Checkout item in version control":

Request example

curl -X PUT \ "http://localhost:9090/api/v1/wkspaces/{wkName}/content/{path}"

Response example

{ "affectedPaths": [ "string" ]}

Move item in version control

Move a specific item within the workspace. This operation updates the item's location in version control and the workspace.

Path parameters for "Move item in version control"

wkName

string
required
The name of the workspace

path

string
required
The path of the item to move, relative to the workspace

Request body for "Move item in version control"

Media Type:
application/json

destination

string
required
No description

HTTP response status codes for "Move item in version control":

Code samples for "Move item in version control":

Request example

curl -X PATCH \ -H "Content-Type: application/json" \ -d '{ "destination": "string"}' \ "http://localhost:9090/api/v1/wkspaces/{wkName}/content/{path}"

Response example

{ "affectedPaths": [ "string" ]}

Delete item from version control

Delete a specific item from the workspace. This operation removes the item from version control and the workspace.

Path parameters for "Delete item from version control"

wkName

string
required
The name of the workspace

path

string
required
The path of the item to delete, relative to the workspace

HTTP response status codes for "Delete item from version control":

Code samples for "Delete item from version control":

Request example

curl -X DELETE \ "http://localhost:9090/api/v1/wkspaces/{wkName}/content/{path}"

Response example

{ "affectedPaths": [ "string" ]}

Get all workspaces

Retrieve a list of all workspaces present in the local machine for the current user.

HTTP response status codes for "Get all workspaces":

Code samples for "Get all workspaces":

Request example

curl -X GET \ "http://localhost:9090/api/v1/wkspaces"

Response example

[ { "name": "string", "guid": "string", "path": "string", "machineName": "string" }]

Create a new workspace

Create a new workspace in the local machine for the current user.

Request body for "Create a new workspace"

Media Type:
application/json

name

string
required
No description

path

string
required
No description

repository

string
No description

HTTP response status codes for "Create a new workspace":

Code samples for "Create a new workspace":

Request example

curl -X POST \ -H "Content-Type: application/json" \ -d '{ "name": "string", "path": "string", "repository": "string"}' \ "http://localhost:9090/api/v1/wkspaces"

Response example

{ "name": "string", "guid": "string", "path": "string", "machineName": "string"}

Get workspace details

Retrieve details about a specific workspace.

Path parameters for "Get workspace details"

wkName

string
required
The name of the workspace

HTTP response status codes for "Get workspace details":

Code samples for "Get workspace details":

Request example

curl -X GET \ "http://localhost:9090/api/v1/wkspaces/{wkName}"

Response example

{ "name": "string", "guid": "string", "path": "string", "machineName": "string"}

Update workspace details

Update the details of a specific workspace.

Path parameters for "Update workspace details"

wkName

string
required
The name of the workspace

Request body for "Update workspace details"

Media Type:
application/json

name

string
required
No description

guid

string
No description

path

string
No description

machineName

string
No description

HTTP response status codes for "Update workspace details":

Code samples for "Update workspace details":

Request example

curl -X PATCH \ -H "Content-Type: application/json" \ -d '{ "name": "string", "guid": "string", "path": "string", "machineName": "string"}' \ "http://localhost:9090/api/v1/wkspaces/{wkName}"

Response example

{ "name": "string", "guid": "string", "path": "string", "machineName": "string"}

Delete a workspace

Delete a specific workspace.

Path parameters for "Delete a workspace"

wkName

string
required
The name of the workspace

HTTP response status codes for "Delete a workspace":

Code samples for "Delete a workspace":

Request example

curl -X DELETE \ "http://localhost:9090/api/v1/wkspaces/{wkName}"

Response example

Get workspace item history

Retrieve the history of changes for a specific item in a workspace.

Path parameters for "Get workspace item history"

wkName

string
required
The name of the workspace

path

string
required
The path of the item in the workspace

HTTP response status codes for "Get workspace item history":

Code samples for "Get workspace item history":

Request example

curl -X GET \ "http://localhost:9090/api/v1/wkspaces/{wkName}/history/{path}"

Response example

[ { "revisionId": 0, "type": "string", "owner": { "name": "string", "isGroup": true }, "creationDate": "2024-01-01T00:00:00Z", "comment": "string", "revisionLink": "string", "changesetId": 0, "changesetLink": "string", "branchName": "string", "branchLink": "string", "repositoryName": "string", "repositoryLink": "string" }]