| Table plus |
|---|
| applyColStyleToCell | true |
|---|
| heading | 0 |
|---|
| columnTypes | s,s,s,s |
|---|
| multiple | false |
|---|
| columnAttributes | style="background:#e5e7ea;font-weight:bold,,style="background:#e5e7ea;font-weight:bold, |
|---|
| enableSorting | false |
|---|
|
Syntax | admArchiveProjectVersion(projectKey, versionName, archive) | Package | adm | Alias | | Pkg Usage | archiveVersion(projectKey, versionName, archive) | |
Description
| Excerpt |
|---|
|
| Archives/unarchives a project version. |
Archives/unarchives a project version.
Parameters
| Table plus |
|---|
| applyColStyleToCell | true |
|---|
| columnTypes | s,s,s,s |
|---|
| heading | 0 |
|---|
| multiple | false |
|---|
| enableSorting | false |
|---|
|
Parameter name | Type | Required | Description |
|---|
projectKey | String | Yes | Project key. | versionName | String | Yes | Version name. | archive | Boolean (true/false) | Yes | Flag for archive(true) or unarchive(false). | |
Return Type
String / Boolean
The return type doesn't have a meaning on server. On cloud it will return true if the version is archived/unarchived and false otherwise.
| Note |
|---|
- If projectKey or versionName is empty, an error will be raised.
- If project or version does not exist, an error will be raised.
|
See also
| Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 25 |
|---|
| showSpace | false |
|---|
| cql | label = "version_admin_routine" and space = currentSpace ( ) |
|---|
| labels | array_routines |
|---|
|