...
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 | Description |
|---|
| snapshotName | String | The name of the snapshot is automatically generated at the time of creation |
| snapshotId | Long | The id of the snapshot is returned after creation |
|---|
| description | String | The description of the snapshot |
| projects | List<Project> | A list of projects associated with the snapshot |
...
| 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) | projectVersionId | Long | The version |
| 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:
| 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<Version> | The version information about the projects associated with the snapshot |
Versions have the following attributes:
| Attributes | Type | Description |
|---|
| projectId | Long | The id of the project |
buildEnvironmentId build environment associated with | version id of the project |
forceBuild| packageName | String | The name of the package (used for partial deployment projects only) |
| requestAllFiles | Boolean | Whether or not the project |
should be force built| was told to request all files |
| snapshotVersionStatus | String | The current status of the snapshot |
Back to Top
...
POST
This POST service will create a new snapshot with the same attributes as the given JSON object.
| Info |
|---|
|
http://host:port/flexdeploy/rest/release/{releaseId}/snapshot |
Parameters
| Attributes | Type | Required | Type | Description |
|---|
| releaseId | Yes | URL | The release to create a snapshot from |
| snapshotName | No | String | The name of the snapshot is automatically generated at the time of creation |
| snapshotId | No | Long | The id of the snapshot is returned after being created |
| description | No | Stringdescription | String | No | The description of the snapshot |
| projects | List<Project> | No | List<Project> | A list of projects associated with the snapshot |
| projectId | Long | Yes | Long | The id of the project |
| packageName | String | Yes* | String | The name of the package (used for partial deployment projects only) |
| projectVersionId | Long | No | Long | The version id of the project to use instead of creating a new version |
| buildEnvironmentId | NoLongLong | Yes | The build environment associated with the project (used for projects with multiple build environments) |
| forceBuild | Boolean | No | Boolean | Whether or not the project should be force built |
*only if it's a partial deployment project
**only if the project has multiple build environments
Defaults
If some information is not included in the JSON object, the following default values will be used:
...
| Code Block |
|---|
| theme | Eclipse |
|---|
| title | POST JSON |
|---|
|
{
"snapshotId": 10005,
"snapshotName": "07-09-2018 12:12:03",
"description": "example snapshot creation",
"projects": [
{
"projectId": 10000,
"packageName": "package1",
"projectVersionId": 10001,
"forceBuildrequestAllFiles": false,
"buildEnvironmentIdsnapshotVersionStatus": 20003"PENDING"
},
{
"projectId": 10000,
"packageName": "package2",
"projectVersionId": null,
"forceBuildrequestAllFiles": truefalse,
"buildEnvironmentIdsnapshotVersionStatus": 20003"PENDING"
},
{
"projectId": 10002,
"packageName": null,
"forceBuildprojectVersionId": falsenull,
"projectVersionIdrequestAllFiles": nullfalse,
"buildEnvironmentIdsnapshotVersionStatus": 10003"PENDING"
}
} |
Back to Top