...
| Table of Contents | ||
|---|---|---|
|
POST
...
- createSnapshot
- promoteToRelease - one and only one snapshotVersionInputs should be provided
...
SnapshotVersionInput has following attributes:
...
(
...
POST (create snapshot)
This POST service will create a new snapshot with the same attributes as the given JSON object.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/releases/{releaseId}/snapshot |
Parameters
POST will receive a snapshot input JSON object and return a snapshot JSON object. Snapshot input JSON objects can have the following attributes:
| Attributes | Type | Required | Description |
|---|---|---|---|
| action | String | Yes | should be set to createSnapshot for this API. |
| description | String | No | The description of the snapshot |
| snapshotVersionInputs | List<SnapshotVersionInputPojo> | No |
|
|
Elements of snapshotVersionInputs has following attributes:
| Attributes | Type | Required | Description |
|---|---|---|---|
| projectId | Long | Yes | Project associated with release. |
| projectVersionId | Long | No | The version id of the project. If project version is not supplied new build will be performed. |
| packageName | String | Yes |
for partial deploy, otherwise No | The name of the package (used for partial deployment projects only) associated with release. If Partial deployment project and packageName is not supplied it will be considered all files type version. |
| buildEnvironmentId | Long | No |
| The build environment associated with the project. If not supplied and only one environment found for build instance then it will be defaulted. | |||
| forceBuild | Boolean | No | Whether or not the project should be force built. This will be overridden to true for partial deployment project. |
* only if it's a partial deployment project
**only if the project has multiple build environments
Response
Snapshot JSON objects can having the following attributes:
...
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/releases/{releaseId}/snapshot |
Parameters
POST will receive a snapshot input JSON object and return a snapshot JSON object. Snapshot input JSON objects can have the following attributes:
| Attributes | Type | Required | Description |
|---|---|---|---|
| action | String | Yes | should be set to promoteToRelease for this API. |
| description | String | No | The description of the snapshot |
| snapshotVersionInputs | List<SnapshotVersionInputPojo> |
| Yes | One and only one element is required for promote to release action. |
Elements of snapshotVersionInputs has following attributes:
| Attributes | Type | Required | Description |
|---|---|---|---|
| projectId | Long | Yes | Project associated with release. |
| projectVersionId | Long | Yes | The version id of the project. If using packageName, version for package must be provided. |
| packageName | String |
| No | The name of the package (used for partial deployment projects only) associated with release. If Partial deployment project and packageName is not supplied it will be considered all files type |
| version |
| . |
Response
Snapshot JSON objects can having the following attributes:
...