VcsRootInstanceApi

getAllVcsRootInstances

Get all VCS root instances.


Endpoint	/app/rest/vcs-root-instances
Produces	`application/xml` `application/json`
Parameters	`locator: string<VcsRootInstanceLocator>` `fields: string`
Response	`VcsRootInstances`

requestPendingChangesCheck

Check for the pending changes for all VCS root instances.


Endpoint	/app/rest/vcs-root-instances/checkingForChangesQueue
Produces	`application/xml` `application/json`
Parameters	`locator: string<VcsRootInstanceLocator>` `requestor: string` `fields: string`
Response	`VcsRootInstances`

triggerCommitHookNotification

Send the commit hook notification.


Endpoint	/app/rest/vcs-root-instances/commitHookNotification
Produces	`text/plain`
Parameters	`locator: string<VcsRootInstanceLocator>` `okOnNothingFound: boolean`

getVcsRootInstance

Get VCS root instance matching the locator.


Endpoint	/app/rest/vcs-root-instances/{vcsRootInstanceLocator}
Produces	`application/xml` `application/json`
Parameters	`vcsRootInstanceLocator: string<VcsRootInstanceLocator>` `fields: string`
Response	`VcsRootInstance`

getFilesList

List all files.


Endpoint	/app/rest/vcs-root-instances/{vcsRootInstanceLocator}/files/latest
Produces	`application/xml` `application/json`
Parameters	`vcsRootInstanceLocator: string<VcsRootInstanceLocator>` `basePath: string` `locator: string` `fields: string`
Response	`Files`

getZippedFile

Get specific file zipped.


Endpoint	/app/rest/vcs-root-instances/{vcsRootInstanceLocator}/files/latest/archived{path}
Produces	`/`
Parameters	`path: string` `vcsRootInstanceLocator: string<VcsRootInstanceLocator>` `basePath: string` `locator: string` `name: string`

downloadFile

Download specific file.


Endpoint	/app/rest/vcs-root-instances/{vcsRootInstanceLocator}/files/latest/files{path}
Produces	`/`
Parameters	`path: string` `vcsRootInstanceLocator: string<VcsRootInstanceLocator>`

getFileMetadata

Get metadata of specific file.


Endpoint	/app/rest/vcs-root-instances/{vcsRootInstanceLocator}/files/latest/metadata{path}
Produces	`application/xml` `application/json`
Parameters	`path: string` `vcsRootInstanceLocator: string<VcsRootInstanceLocator>` `fields: string`
Response	`file`

getFilesListForSubpath

List files under this path.


Endpoint	/app/rest/vcs-root-instances/{vcsRootInstanceLocator}/files/latest/{path}
Produces	`application/xml` `application/json`
Parameters	`path: string` `vcsRootInstanceLocator: string<VcsRootInstanceLocator>` `basePath: string` `locator: string` `fields: string`
Response	`Files`

getVcsRootInstanceProperties

Get all properties of the matching VCS root instance.


Endpoint	/app/rest/vcs-root-instances/{vcsRootInstanceLocator}/properties
Produces	`application/xml` `application/json`
Parameters	`vcsRootInstanceLocator: string<VcsRootInstanceLocator>` `fields: string`
Response	`Properties`

deleteVcsRootInstanceRepositoryState

Delete the last repository state of the matching VCS root instance.


Endpoint	/app/rest/vcs-root-instances/{vcsRootInstanceLocator}/repositoryState
Parameters	`vcsRootInstanceLocator: string<VcsRootInstanceLocator>`

getVcsRootInstanceRepositoryState

Get the repository state of the matching VCS root instance.


Endpoint	/app/rest/vcs-root-instances/{vcsRootInstanceLocator}/repositoryState
Produces	`application/xml` `application/json`
Parameters	`vcsRootInstanceLocator: string<VcsRootInstanceLocator>` `fields: string`
Response	`Entries`

setVcsRootInstanceRepositoryState

Update the repository state of the matching VCS root instance.


Endpoint	/app/rest/vcs-root-instances/{vcsRootInstanceLocator}/repositoryState
Consumes	`application/xml` `application/json`
Produces	`application/xml` `application/json`
Parameters	`vcsRootInstanceLocator: string<VcsRootInstanceLocator>` `body: Entries` `fields: string`
Response	`Entries`

getVcsRootInstanceCreationDate

Get the creation date of the matching VCS root instance.


Endpoint	/app/rest/vcs-root-instances/{vcsRootInstanceLocator}/repositoryState/creationDate
Consumes	`text/plain`
Produces	`text/plain`
Parameters	`vcsRootInstanceLocator: string<VcsRootInstanceLocator>`
Response	`string`

deleteVcsRootInstanceField

Remove a field of the matching VCS root instance.


Endpoint	/app/rest/vcs-root-instances/{vcsRootInstanceLocator}/{field}
Parameters	`vcsRootInstanceLocator: string<VcsRootInstanceLocator>` `field: string`

getVcsRootInstanceField

Get a field of the matching VCS root instance.


Endpoint	/app/rest/vcs-root-instances/{vcsRootInstanceLocator}/{field}
Produces	`text/plain`
Parameters	`vcsRootInstanceLocator: string<VcsRootInstanceLocator>` `field: string`
Response	`string`

setVcsRootInstanceField

Get a field of the matching VCS root instance.


Endpoint	/app/rest/vcs-root-instances/{vcsRootInstanceLocator}/{field}
Consumes	`text/plain`
Produces	`text/plain`
Parameters	`vcsRootInstanceLocator: string<VcsRootInstanceLocator>` `field: string` `body: string`
Response	`string`

Last modified: 30 March 2022