This POST service will perform the same action found on the Populate button off the project files screen. It will populate files from the configured SCM.
API URL
http://host:port/flexdeploy/rest/v1/project/{Id}/populate
Request
| Parameter | Required | Type | Description |
|---|---|---|---|
| environmentId | Y | Long | This is the environment id, not the environment name that is seen on most screens. |
| projectId | Y | Long | The Id of the project to deploy. |
| projectStreamId | Y | Long | The project stream to to commit the modified files to. |
Response Codes
| HTTP Code | Description |
|---|---|
| 204 | Populate completed successfully |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 404 | Project not found |
| 500 | Unexpected internal server error |
Example Populate Request
We can populate a project with Id 10004 with the following request:
API URLs
http://host:port/flexdeploy/rest/v1/project/10004/populate
{
"environmentId":12345,
"packageName":"package1",
"projectStreamId": 54321
}
Populate From Salesforce
This POST service will execute the same actions as the Salesforce tab when pulling from Salesforce and committing to an SCM. If a package name is specified modified files will be added to the package.
Request
| Parameter | Required | Type | Description |
|---|---|---|---|
| environmentId | Y | Long | This is the environment id, not the environment name that is seen on most screens. |
| accountCode | Y | String | The code for the Salesforce account on the integration instance code to pull objects from. |
| packageName | N | String | The name of the package to add modified files to. |
| projectId | Y | Long | The Id of the project to deploy. |
| projectStreamId | Y | String | The project stream to to commit the modified files to. |
| partialDeployments | N | Boolean | Whether or not the project is a partial deployment project. |
Response Codes
| HTTP Code | Description |
|---|---|
| 204 | Populate completed successfully |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 404 | Project not found |
| 500 | Unexpected internal server error |
Example Populate Request
We can populate a project with Id 10004 with the following request:
API URLs
http://host:port/flexdeploy/rest/v1/project/10004/populate/salesforce
{
"environmentId":12345,
"accountCode": "FLEXAGON9",
"packageName":"package1",
"projectStreamId": 54321,
"partialDeployments": true
}