Project API PATCH

This PATCH service will update an existing project with the information passed through a JSON object. PATCH will only modify the attributes provided in input, and leave all other project attributes unchanged.

API URLs

http://host:port/flexdeploy/rest/v1/project/{projectId}

Request

PATCH will receive a project input JSON object and return a project JSON object. Project input JSON objects for the request can have the following attributes:

Parameter
Type
Description
projectIdURLId of the project to patch.
projectNameStringUnique name of the project.
applicationIdLong

Id of the application the project is in. 

projectPathString

Fully qualified project path.

isActiveBooleanBoolean that tracks whether or not the project is active. Null input defaults to true.
packageBuildTypeStringString that defines usage of packages and build or deployments of packages. Possible values are ALL, PACKAGE, or BOTH. Defaults to Project Default or BOTH if Project Default is empty.
descriptionStringDescription of the project.
priorityIntegerDeploy priority of the project. Null input defaults to 1.
webhooksEnabledBooleanWhether or not webhooks are enabled. Null input defaults to false.
projectBuildSequenceInteger@since 5.4.0.2 Update the value for the ProjectBuildSequence variable which can be used in stream syntax scripts.
projectTypeProjectTypeEnum

Type of project. Possible values are GENERAL, EBS, PARTIAL_FILE, PARTIAL_JDBC, OracleForms, ORACLE_DB, ORACLE_BI, ORACLE_APEX, MFT, SALESFORCE, UTILITY, MDS, or GENERIC.

scmTypeSCMTypeEnum

This specifies the source control management system used by this project. Must be a valid source control management system. Possible values are SVN, GIT, CVS, TFVC, PERF, PVCS, FILE, or NONE.

priorityScopeStringThis specifies the priority scope of the current project. Either Global, Folder, or Application. Null input defaults to Application.
buildInfoProjectBuildInfoBuild info for the project. See more info about the ProjectBuildInfo object below.
preDeployInfoProjectPreDeployInfo@since 5.5.0.0 PreDeploy info for the project. See more info about the ProjectPreDeployInfo object below.
deployInfoProjectDeployInfoDeploy info for the project. See more info about the ProjectDeployInfo object below.
utilityExecutionInfoUtilityProjectExecutionInfoExecution info for a utility project. See more info about the UtilityProjectExecutionInfo object below.
mainStreamNameStringName of the main stream for the project. Null input defaults to master.
scmConfigurationProjectSCMPojoSCM configuration for the project. See more info about the ProjectSCMPojo object below.
contianerConfigurationContainerConfigurationContainer configuration for the project. See more info about the ContainerConfiguration type below.

ProjectBuildInfo

AttributeTypeDescription
workflowIdLongId of the build workflow used by this project.
instanceIdLongId of the instance where this project is built.

ProjectPreDeployInfo

AttributeRequiredTypeDescription
workflowIdYesLong

Id of the predeployment workflow used by this project.

Note - If predeploy workflow is used, then ProjectDeployInfo.instanceIds is needed

ProjectDeployInfo

AttributeTypeDescription
workflowIdLongId of the deployment workflow used by this project.
instanceIdsList<Long>Id of each of the instances where the project can be deployed. New instance ids will be added to the existing list of instance ids for deployment.

UtilityProjectExecutionInfo

AttributeTypeDescription
workflowIdLongId of the utility workflow used by this project.
instanceIdsList<Long>Id of each of the utility instance where this project can be run. New instance ids will be added to the existing list of instance ids.

ProjectSCMPojo

AttributeTypeDescription
sourcesList<ProjectSCMConfig>List of SCM configuration sources. See more info about the ProjectSCMConfig object below.

ProjectSCMConfig

AttributeTypeDescription
instanceIdLongSCM instance id for this source.
configValuesList<ProjectSCMConfigValue>Configuration values for each SCM source. See more info about the ProjectSCMConfigValue object below.
sourceNumberIntegerNumber for the source. Source numbers start at 1 and increment for each source after that.

ProjectSCMConfigValue

AttributeTypeDescription
configNameStringName of the configuration attribute.
configValueString

Value of the configuration attribute.

ContainerConfiguration

AttributeTypeDescription
dockerFileStringName of the dockerfile
dockerStreamsList<DockerStream>Information about the docker streams. See more info about the DockerStream type below.
kubernetesConfigurationKubernetesConfigurationConfiguration for Kubernetes. See more info about the KubernetesConfiguration type below.

DockerStream

AttributeTypeDescription
streamIdLongId of the stream.
streamNameStringName of the stream.
imageNameStringName of the image.
isImageBuildBooleanIf the image will build.
isImagePushBooleanIf the image will push. Null if isImageBuild is false.

KubernetesConfiguration

AttributeTypeDescription
deploymentNameStringName of the deployment.
manifestsToDeployList<String>Manifests to deploy.
blueGreenManifestsList<String>Blue green manifests.
canaryManifestsList<String>

Canary manifests.

abmanifestsList<String>AB manifests.
helmConfigurationHelmConfigurationThe helm configuration. See more info about the HelmConfiguration type below.

HelmConfiguration

AttributeTypeDescription
chartStringName of the chart.
releaseNameStringName of the release.
parametersMapList<ParameterMap>All of the parameter mappings. See more info about the ParmaterMap type below.

ParameterMap

AttributeTypeDescription
keyStringKey for the parameter map.
valueStringValue for the parameter map.

SCM Configuration Names by Type

All values not provided are defaulted. All defaults are configured from the Administration > Defaults page.


 Subversion SCM Configuration Names
Attribute NameDescription
TrunkScriptPath for the trunk within selected repository.
BranchScriptPath for the branches within selected repository. Use StreamName variable to identify branch name used at runtime.
TagScriptPath for the tag within the selected repository. Use ProjectVersion variable to specify identifier of current build.
CheckoutFolderScript

Optional sub-folder to use for export/checkout operations during build workflow execution.

 Git SCM Configuration Names
Attribute NameDescription
BranchScriptPath for the branches within selected repository. Use StreamName variable to identify branch name used at runtime.
TagScriptPath for the tag within the selected repository. Use ProjectVersion variable to specify identifier of current build.
SparseCheckoutFoldersScript

This is very useful when you have many folders in your Git repository, but your project only needs few folders for build. This can be specified as one more values by using comma. 

CheckoutFolderScriptOptional sub-folder to use for clone operation during build workflow execution.
 CVS SCM Configuration Names
Attribute NameDescription
ModuleNamesScriptModule Names or Module subdirectories to be selected from repository. Module subdirectories should traverse starting at the Module Name. Multiple Modules may be selected by separating the names/paths with commas.
BranchNameScriptPath for the branches within selected repository. Use StreamName variable to identify branch name used at runtime.
TagScript

Tag script to be used when creating tags for the project in the repository. Use ProjectVersion variable to specify identifier of current build.

CheckoutFolderScriptOptional sub-folder to use for clone operation during build workflow execution.
 TFVC SCM Configuration Names
Attribute NameDescription
MainScriptMain Path to a project in the selected repository.
BranchScriptPath for the branches within selected repository. Use StreamName variable to identify branch name used at runtime.
LabelNameScript

Label script to be used when creating labels for the project in the repository. Use ProjectVersion variable to specify identifier of current build.

GetFolderScriptOptional sub-folder to use for clone operation during build workflow execution.
 PVCS SCM Configuration Names
Attribute NameDescription
ProjectPathScriptProject Path Script to be used to get files from.  This will be a path present in the Project Database configured on the instance.  Use "/" to get all files in the Project Database.
PromotionGroupScriptPromotion Group name to be used.  Use StreamName variable to identify Promotion Group name at runtime.
UsingPGScript

Whether the Promotion Group script should be used to identify the stream.  If false, then the branch script will be used.

BranchScriptBranch name to be used within selected repository. Use StreamName variable to identify branch name used at runtime.
LabelScriptLabel script to be used when creating labels for the project in the repository. Use ProjectVersion variable to specify identifier of current build.
CheckoutFolderScriptOptional sub-folder to use for clone operation during build workflow execution.
 PERF SCM Configuration Names
Attribute NameDescription
MainScriptMain Path to a project in the selected repository.
BranchScriptBranch name to be used within selected repository. Use StreamName variable to identify branch name used at runtime.
LabelNameScriptLabel script to be used when creating labels for the project in the repository. Use ProjectVersion variable to specify identifier of current build.
CheckoutFolderScriptOptional sub-folder to use for clone operation during build workflow execution.
 CCUCM SCM Configuration Names
Attribute NameDescription
ProjectVobScriptProject versioned object base script.
VobPathsScriptScript for versioned object base path.
LabelNameScriptLabel script to be used when creating labels for the project in the repository. Use ProjectVersion variable to specify identifier of current build.
CheckoutFolderScriptOptional sub-folder to use for clone operation during build workflow execution.
StreamScriptScript for stream.
 FILE SCM Configuration Names
Attribute NameDescription
MainFolderScriptMain Path to a project in the selected repository.
BranchFolderScriptBranch name to be used within selected repository. Use StreamName variable to identify branch name used at runtime.
CheckoutFolderScriptOptional sub-folder to use for clone operation during build workflow execution.

Response

AttributeTypeDescription

projectId

Long

Id of the project.

projectName

String

Unique name of the project.

applicationId

String

Id of the application the project is in.

projectPath

String

Fully qualified project path.

isActive

Boolean

Boolean that tracks whether or not the project is active. Null input defaults to true.

packageBuildTypeStringString that defines usage of packages and build or deployments of packages. Possible values are ALL, PACKAGE, or BOTH. Defaults to Project Default or BOTH if Project Default is empty.

description

String

Description of the project.

projectClassification

String

The classification of the project, such as "Standard" or "PartialDeployments"

priority

Integer

Deploy priority of the project.

webhooksEnabledBooleanWhether or not webhooks are enabled.
projectBuildSequenceInteger@since 5.4.0.2 The current value for the next ProjectBuildSequence number.

projectType

ProjectTypeEnum

Type of project. Possible values are GENERAL, EBS, PARTIAL_FILE, PARTIAL_JDBC, OracleForms, ORACLE_DB, ORACLE_BI, ORACLE_APEX, MFT, SALESFORCE, UTILITY, MDS, or GENERIC.

scmType

SCMTypeEnum

This specifies the source control management system used by this project. Must be a valid source control management system. Possible values are SVN, GIT, CVS, TFVC, PERF, PVCS, FILE, or NONE.

priorityScope

String

This specifies the priority scope of the current project. Either Global, Folder, or Application.

buildInfo

ProjectBuildInfo

Build info for the project. See more info about the ProjectBuildInfo object below.

preDeployInfoProjectPreDeployInfo@since 5.5.0.0 PreDeploy info for the project. See more info about the ProjectPreDeployInfo object below.

deployInfo

ProjectDeployInfo

Deploy info for the project. See more info about the ProjectDeployInfo object below.

utilityExecutionInfo

UtilityProjectExecutionInfo

Execution info for a utility project. See more info about the UtilityProjectExecutionInfo object below.

streams

List<Long>

List of ids which identify the project streams associated with this project.

mainStreamName

String

Name of the main stream for the project.

scmConfiguration

ProjectSCMPojo

SCM configuration for the project. See more info about the ProjectSCMPojo object below.

containerConfigurationContainerConfiguration

Container configuration for the project. See more info about the ContainerConfiguration type below.

linksList<Link>List of any relevant links for the object.

ProjectBuildInfo

AttributeTypeDescription
workflowIdLongId of the build workflow used by this project.
instanceIdLongId of the instance where this project is built.

ProjectPreDeployInfo

AttributeTypeDescription
workflowIdLong

Id of the predeployment workflow used by this project.

Note - If predeploy workflow is used, then ProjectDeployInfo.instanceIds is needed

ProjectDeployInfo

AttributeTypeDescription
workflowIdLongId of the deployment workflow used by this project.
instanceIdsList<Long>Id of each of the instances where the project can be deployed.

UtilityProjectExecutionInfo

AttributeTypeDescription
workflowIdLongId of the utility workflow used by this project.
instanceIdsList<Long>Id of each of the utility instance where this project can be run.

ProjectSCMPojo

AttributeTypeDescription
sourcesList<ProjectSCMConfig>List of SCM configuration sources. See more info about the ProjectSCMConfig object below.

ProjectSCMConfig

AttributeTypeDescription
instanceIdLongSCM instance id for this source.
configValuesList<ProjectSCMConfigValue>Configuration values for each SCM source. See more info about the ProjectSCMConfigValue object below.
sourceNumberIntegerNumber for the source. Source numbers start at 1 and increment for each source after that.

ProjectSCMConfigValue

AttributeTypeDescription
configNameStringName of the configuration attribute.
configValueStringValue of the configuration attribute.

ContainerConfiguration

AttributeTypeDescription
dockerFileStringName of the dockerfile
dockerStreamsList<DockerStream>Information about the docker streams. See more info about the DockerStream type below.
kubernetesConfigurationKubernetesConfigurationConfiguration for Kubernetes. See more info about the KubernetesConfiguration type below.

DockerStream

AttributeTypeDescription
streamIdLongId of the stream.
streamNameStringName of the stream.
imageNameStringName of the image.
isImageBuildBooleanIf the image will build.
isImagePushBooleanIf the image will push. Null if isImageBuild is false.
isTagLatestBooleanIf the image will be tagged as latest
registryAccountStringThe Docker Registry Account Code to push to.
imageScanBooleanIf the image will be scanned with Anchore.
containerDockerStreamContainerContainer configuration during deployment

DockerStreamContainer

AttributeTypeDescription
runContainer
BooleanRun a container with this image during deployment
containerName
StringGroovy Script of the container name to run
volumesStringGroovy Script of the volumes to bind to the container
portsBooleanGroovy Script of the ports to bind to the container
additionalParamsBooleanGroovy Script for any additional arguments to pass the run container command

KubernetesConfiguration

AttributeTypeDescription
deploymentNameStringName of the deployment.
manifestsToDeployList<String>Manifests to deploy.
blueGreenManifestsList<String>Blue green manifests.
canaryManifestsList<String>

Canary manifests.

abmanifestsList<String>AB manifests.
helmConfigurationHelmConfigurationThe helm configuration. See more info about the HelmConfiguration type below.

HelmConfiguration

AttributeTypeDescription
chartStringName of the chart.
releaseNameStringName of the release.
parametersMapList<ParameterMap>All of the parameter mappings. See more info about the ParmaterMap type below.

ParameterMap

AttributeTypeDescription
keyStringKey for the parameter map.
valueStringValue for the parameter map.

Link

AttributeTypeDescription
typeStringType of the link "REST", "UI"
linkStringPhysical link of the object.

Response Codes

HTTP CodeDescription
200Projects were found and returned
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
500Unexpected internal server error

Example

If the following project object exists,

Existing Project
{
    "projectName": "Example Project",
    "projectId": 10002,
    "projectPath": "FlexDeploy/Testing/Example Project",
    "description": null,
    "isActive": true,
    "projectClassification": "Container",
    "priority": 1,
    "priorityScope": "Application",
    "applicationId": 14852,
    "scmType": "GIT",
    "mainStreamName": "master",
    "streams": [73419],
    "buildInfo": null,
	"webhooksEnabled": false,
    "deployInfo": {
        "instanceIds": [80524],
        "workflowId": 34540
    },
    "utilityExecutionInfo": null,
    "scmConfiguration": {
        "sources": [
            {
                "instanceId": 16465,
                "configValues": [
                    {
                        "configName": "SparseCheckoutFoldersScript",
                        "configValue": "\"mainfolder/main\""
                    }
                ],
                "sourceNumber": 1
            }
        ]
    },
	"containerConfiguration": {,
        "dockerfile": "docker file name"
        "dockerStreams": [
            {
                "isImageBuild": true,
                "isImagePush": false,
                "streamName": "master",
                "streamId": 12345,
                "imageName": "image name"
            }
        ],
        "kubernetesConfiguration": {
            "manifestsToDeploy": [
                "deploymanifest1"
            ],
            "blueGreenManifests": [
                "bluegreenmanifest1",
                "bluegreenmanifest2"
            ],
            "canaryManifests": [
                "canarymanifest1"
            ],
            "abmanifests": [
                "abmanifest1",
                "abmanifest2",
                "abmanifest3"
            ],
            "helmConfiguration": {
                "parametersMap": [
                    {
                        "key": "key1",
                        "valueScript": "value1"
                    },
                    {
                        "key": "key2",
                        "valueScript": "value2"
                    }
                ],
                "releaseName": "release name",
                "chart": "chart name"
            },
            "deploymentName": "deployment name"
        }
}


and a PATCH request is sent to http://host:port/flexdeploy/rest/v1/project/10002 receiving the following JSON project object, 

PATCH Request JSON
{
    "projectPath": "/FlexDeploy/REST/Example Project",
    "description": "Project created with API",
    "priority": 2,
    "mainStreamName": "master",
	"webhooksEnabled": true,
    "buildInfo": {
        "instanceId": 15925,
        "workflowId": 43164
    },
    "preDeployInfo": {
        "workflowId": 42978
    },
    "scmConfiguration": {
        "sources": [
            {
                "instanceId": 42863,
                "configValues": [
                    {
                        "configName": "SparseCheckoutFoldersScript",
                        "configValue": "\"EBS\""
                    }
                ],
                "sourceNumber": 2
            }
        ]
    },
	"containerConfiguration": {,
        "dockerfile": "new docker file name"
        "dockerStreams": [
            {
                "isImageBuild": false,
                "isImagePush": null,
                "streamName": "master",
                "imageName": "new image name"
            }
        ],
        "kubernetesConfiguration": {
            "manifestsToDeploy": [
                "deploymanifest1"
            ],
            "blueGreenManifests": [
                "bluegreenmanifest1"
            ],
            "canaryManifests": [
                "canarymanifest1"
            ],
            "abmanifests": [
                "abmanifest1",
                "abmanifest2"
            ],
            "helmConfiguration": {
                "parametersMap": [
                    {
                        "key": "key1",
                        "valueScript": "new value"
                    }
                ],
                "releaseName": "new release name",
                "chart": "new chart name"
            },
            "deploymentName": "new deployment name"
        }
}

the following project object will then be patched in FlexDeploy:

PATCH Response JSON
{
    "projectName": "Example Project",
    "projectPath": "/FlexDeploy/REST/Example Project",
    "description": "Project created with API",
    "isActive": true,
    "projectClassification": "Container",
    "priority": 2,
    "priorityScope": "Application",
    "applicationId": 49628,
    "scmType": "GIT",
    "mainStreamName": "master",
	"webhooksEnabled": true,
    "buildInfo": {
        "instanceId": 15925,
        "workflowId": 43164
    },
    "deployInfo": {
        "instanceIds": [80524],
        "workflowId": 34540
    },
    "preDeployInfo": {
        "workflowId": 42978
    },
    "scmConfiguration": {
        "sources": [
            {
                "instanceId": 16465,
                "configValues": [
                    {
                        "configName": "SparseCheckoutFoldersScript",
                        "configValue": "\"mainfolder/main\""
                    }
                ],
                "sourceNumber": 1
            },
			{
                "instanceId": 42863,
                "configValues": [
                    {
                        "configName": "SparseCheckoutFoldersScript",
                        "configValue": "\"EBS\""
                    }
                ],
                "sourceNumber": 2
            }
        ]
    },
	"containerConfiguration": {,
        "dockerfile": "new docker file name"
        "dockerStreams": [
            {
                "isImageBuild": false,
                "isImagePush": null,
                "streamName": "master",
                "imageName": "new image name"
            }
        ],
        "kubernetesConfiguration": {
            "manifestsToDeploy": [
                "deploymanifest1"
            ],
            "blueGreenManifests": [
                "bluegreenmanifest1"
            ],
            "canaryManifests": [
                "canarymanifest1"
            ],
            "abmanifests": [
                "abmanifest1",
                "abmanifest2"
            ],
            "helmConfiguration": {
                "parametersMap": [
                    {
                        "key": "key1",
                        "valueScript": "new value"
                    }
                ],
                "releaseName": "new release name",
                "chart": "new chart name"
            },
            "deploymentName": "new deployment name"
        }
}


The following macros are not currently supported in the footer:
  • style