...
| Attributes | Type | Description |
|---|---|---|
| projectId | Long | The id of the project |
| projectVersionId | Long | The version id of the project |
| packageName | String | The name of the package (used for partial deployment projects only) |
| buildEnvironmentId | Long | The build environment associated with the project |
| forceBuild | Boolean | Whether or not the project should be force built |
Snapshot JSON objects can having the following attributes:
...
snapshotId
...
SnapshotVersion has following attributes:
...
POST (create snapshot)
This POST service will create a new snapshot with the same attributes as the given JSON object.
...
**only if the project has multiple build environments
Response
Snapshot JSON objects can having the following attributes:
| Attributes | Type | Description |
|---|---|---|
snapshotId | Long | The id of the snapshot |
| snapshotName | String | The name of the snapshot, which is the time when the snapshot was created |
| snapshotStatus | String | The status of the snapshot |
| description | String | The description of the snapshot |
| snapshotVersions | List<SnapshotVersionPojo> | The version information about the projects associated with the snapshot |
Elements of snapshotVersions has following attributes:
| Attributes | Type | Description |
|---|---|---|
| projectId | Long | The id of the project |
| projectStreamId | Long | Stream included in release for the project. |
| projectVersionId | Long | The version id of the project |
| packageName | String | The name of the package (used for partial deployment projects only) |
| requestAllFiles | Boolean | Whether or not the project was told to request all files |
| snapshotVersionStatus | String | The current status of the snapshot |
Example
If the POST request sent to http://host:port/flexdeploy/rest/releases/12345/snapshot receives the following JSON environment object,
...
| 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> | No | A list containing only one project version to be associated with latest snapshot. |
| Parameters for each element of snapshotVersionInputs. One and only one element is required for promote to release action. | |||
| projectId | Long | Yes | Project associated with release. |
| packageName | String | Yes* | 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. |
| projectVersionId | Long | Yes | The version id of the project. If using packageName, version for package must be provided. |
Response
Snapshot JSON objects can having the following attributes:
| Attributes | Type | Description |
|---|---|---|
snapshotId | Long | The id of the snapshot |
| snapshotName | String | The name of the snapshot, which is the time when the snapshot was created |
| snapshotStatus | String | The status of the snapshot |
| description | String | The description of the snapshot |
| snapshotVersions | List<SnapshotVersionPojo> | The version information about the projects associated with the snapshot |
Elements of snapshotVersions has following attributes:
| Attributes | Type | Description |
|---|---|---|
| projectId | Long | The id of the project |
| projectStreamId | Long | Stream included in release for the project. |
| projectVersionId | Long | The version id of the project |
| packageName | String | The name of the package (used for partial deployment projects only) |
| requestAllFiles | Boolean | Whether or not the project was told to request all files |
| snapshotVersionStatus | String | The current status of the snapshot |
Example
If the previous snapshot had the following attributes:
...