Unity Version Control CM API
Overview
The Unity Version Control API allows developers to perform Unity Version Control operations in their machine,
provided that a Unity Version Control client is already installed and configured.
cmFor more information about Unity Version Control, refer to our
documentation.
Download OpenAPI specification:
Get branches
Retrieve the list of branches in a repository
Code samples for "{title}":
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
Code samples for "{title}":
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
Code samples for "{title}":
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
Code samples for "{title}":
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
Code samples for "{title}":
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
Code samples for "{title}":
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
Code samples for "{title}":
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
Code samples for "{title}":
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
Code samples for "{title}":
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
Code samples for "{title}":
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" }}
Get pending changes
Code samples for "{title}":
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 } } }]
Get changesets
Retrieve a list of changesets in a repository
Code samples for "{title}":
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
Code samples for "{title}":
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
Code samples for "{title}":
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
Code samples for "{title}":
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
Code samples for "{title}":
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
Code samples for "{title}":
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 file information
Code samples for "{title}":
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.
Code samples for "{title}":
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
Code samples for "{title}":
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.
Code samples for "{title}":
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.
Code samples for "{title}":
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" }}
Get a specific revision in a label
Code samples for "{title}":
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
Code samples for "{title}":
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" }]
Create a new repository
Code samples for "{title}":
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"}
Update a specific repository
This endpoint allows you to update a specific repository by name.
Code samples for "{title}":
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"}
Get a specific revision
Code samples for "{title}":
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" }}
Add item to version control
Mark a private or ignored item for inclusion in version control
Code samples for "{title}":
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
Move item in version control
Get all workspaces
Retrieve a list of all workspaces present in the local machine for the current user.
Update workspace details
Code samples for "{title}":
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"}
Get workspace item history
Code samples for "{title}":
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" }]