Project API Populate

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

ParameterRequiredTypeDescription
environmentIdYLongThis is the environment id, not the environment name that is seen on most screens.
projectIdYLongThe Id of the project to deploy.
projectStreamIdYLong

The project stream to to commit the modified files to.

Response Codes

HTTP CodeDescription
204Populate completed successfully
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
404Project not found
500Unexpected 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

ParameterRequiredTypeDescription
environmentIdYLongThis is the environment id, not the environment name that is seen on most screens.
accountCodeYString

The code for the Salesforce account on the integration instance code to pull objects from.

packageNameNStringThe name of the package to add modified files to.
projectIdYLongThe Id of the project to deploy.
projectStreamIdYString

The project stream to to commit the modified files to.

partialDeploymentsNBooleanWhether or not the project is a partial deployment project.

Response Codes

HTTP CodeDescription
204Populate completed successfully
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
404Project not found
500Unexpected internal server error

Example Populate Request

We can populate a project with Id 10004 with the following request:

API URLs

{
	"environmentId":12345,
	"accountCode": "FLEXAGON9",
	"packageName":"package1",
	"projectStreamId": 54321,
	"partialDeployments": true
}
The following macros are not currently supported in the footer:
  • style