VersionedSettingsApi

getVersionedSettingsProjectsToLoad

Get a list of projects that are affected by Load Settings from VCS action.


Endpoint	/app/rest/projects/{locator}/versionedSettings/affectedProjects
Parameters	`locator: string<ProjectLocator>` `fields: string`
Response	`Projects`

Check for changes in Versioned Settings.


Endpoint	/app/rest/projects/{locator}/versionedSettings/checkForChanges
Parameters	`locator: string<ProjectLocator>`

Perform Versioned Settings action: Commit current settings to VCS.


Endpoint	/app/rest/projects/{locator}/versionedSettings/commitCurrentSettings
Parameters	`locator: string<ProjectLocator>`

Get Versioned Settings config.


Endpoint	/app/rest/projects/{locator}/versionedSettings/config
Parameters	`locator: string<ProjectLocator>` `fields: string`
Response	`VersionedSettingsConfig`

Set Verseioned Settings config.


Endpoint	/app/rest/projects/{locator}/versionedSettings/config
Parameters	`locator: string<ProjectLocator>` `body: VersionedSettingsConfig` `fields: string`
Response	`VersionedSettingsConfig`

Delete Versioned Settings config parameter value.


Endpoint	/app/rest/projects/{locator}/versionedSettings/config/parameters/{name}
Parameters	`locator: string<ProjectLocator>` `name: string`

Get Versioned Settings config parameter value.


Endpoint	/app/rest/projects/{locator}/versionedSettings/config/parameters/{name}
Produces	`text/plain`
Parameters	`locator: string<ProjectLocator>` `name: string`
Response	`string`

Set Versioned Settings config parameter value.


Endpoint	/app/rest/projects/{locator}/versionedSettings/config/parameters/{name}
Consumes	`text/plain`
Produces	`text/plain`
Parameters	`locator: string<ProjectLocator>` `name: string` `body: string`
Response	`string`

Get Versioned Settings Context Parameters.


Endpoint	/app/rest/projects/{locator}/versionedSettings/contextParameters
Parameters	`locator: string<ProjectLocator>`
Response	`VersionedSettingsContextParameters`

Set Versioned Settings Context Parameters.


Endpoint	/app/rest/projects/{locator}/versionedSettings/contextParameters
Parameters	`locator: string<ProjectLocator>` `body: VersionedSettingsContextParameters`
Response	`VersionedSettingsContextParameters`

Perform Versioned Settings action: Load Setting from VCS.


Endpoint	/app/rest/projects/{locator}/versionedSettings/loadSettings
Parameters	`locator: string<ProjectLocator>` `fields: string`
Response	`Projects`

Get current status of Versioned Settings.


Endpoint	/app/rest/projects/{locator}/versionedSettings/status
Parameters	`locator: string<ProjectLocator>` `fields: string`
Response	`VersionedSettingsStatus`

Delete Versioned Settings Tokens.


Endpoint	/app/rest/projects/{locator}/versionedSettings/tokens
Parameters	`locator: string<ProjectLocator>` `body: VersionedSettingsTokens`
Response	`VersionedSettingsTokens`

Get Versioned Settings Tokens.


Endpoint	/app/rest/projects/{locator}/versionedSettings/tokens
Parameters	`locator: string<ProjectLocator>` `status: string`
Response	`VersionedSettingsTokens`

Add Versioned Settings Tokens.


Endpoint	/app/rest/projects/{locator}/versionedSettings/tokens
Parameters	`locator: string<ProjectLocator>` `body: VersionedSettingsTokens`
Response	`VersionedSettingsTokens`

Last modified: 27 March 2024