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.
| Info |
|---|
|
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:
| | |
|---|
| projectId | URL | Id of the project to patch. |
| projectName | String | Unique name of the project. |
| applicationId | Long | 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. |
| packageBuildType | String | String 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. |
| priority | Integer | Deploy priority of the project. Null input defaults to 1. |
| projectTypewebhooksEnabled | ProjectTypeEnum | Type of project. Possible values are GENERALBoolean | Whether or not webhooks are enabled. Null input defaults to false. |
| projectBuildSequence | Integer | @since 5.4.0.2 Update the value for the ProjectBuildSequence variable which can be used in stream syntax scripts. |
| 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. Null input defaults to Application. |
| buildInfo | ProjectBuildInfo | Build info for the project. See more info about the ProjectBuildInfo object below. |
| preDeployInfo | ProjectPreDeployInfo | @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. |
| mainStreamName | String | Name of the main stream for the project. Null input defaults to master. |
| scmConfiguration | ProjectSCMPojo | SCM configuration for the project. See more info about the ProjectSCMPojo object below. |
...
| Attribute | Type | Description |
|---|
buildWorkflowId| ContainerConfiguration | Container configuration for the project. See more info about the ContainerConfiguration type below. |
ProjectBuildInfo
| Attribute | Type | Description |
|---|
| workflowId | Long | Id of the build workflow used by this project. |
| buildInstanceIdinstanceId | Long | Id of the instance where this project is built. |
ProjectPreDeployInfo
| Attribute | Required | Type | Description |
|---|
| workflowId | Yes | Long | Id of the predeployment workflow used by this project. Note - If predeploy workflow is used, then ProjectDeployInfo.instanceIds is needed |
ProjectDeployInfo
| Attribute | Type | Description |
|---|
| deployWorkflowIdworkflowId | Long | Id of the deployment workflow used by this project. |
| deployInstanceIdsinstanceIds | List<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
| Attribute | Type | Description |
|---|
| utilityWorkflowIdworkflowId | Long | Id of the utility workflow used by this project. |
| utilityInstanceIdsinstanceIds | List<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. |
...
| Attribute | Type | Description |
|---|
| configName | String | Name of the configuration attribute. |
| configValue | String | Value of the configuration attribute. |
SCM Configuration Names by Type
| Tip |
|---|
All values not provided are defaulted. All defaults are configured from the Administration > Defaults page. |
...
| title | Subversion SCM Configuration Names |
|---|
...
Optional sub-folder to use for export/checkout operations during build workflow execution.
...
| title | Git SCM Configuration Names |
|---|
...
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.
...
| title | CVS SCM Configuration Names |
|---|
...
Tag script to be used when creating tags for the project in the repository. Use ProjectVersion variable to specify identifier of current build.
...
ContainerConfiguration
| Attribute | Type | Description |
|---|
| dockerFile | String | Name of the dockerfile |
| dockerStreams | List<DockerStream> | Information about the docker streams. See more info about the DockerStream type below. |
| kubernetesConfiguration | KubernetesConfiguration | Configuration for Kubernetes. See more info about the KubernetesConfiguration type below. |
DockerStream
| Attribute | Type | Description |
|---|
| streamId | Long | Id of the stream. |
| streamName | String | Name of the stream. |
| imageName | String | Name of the image. |
| isImageBuild | Boolean | If the image will build. |
| isImagePush | Boolean | If the image will push. Null if isImageBuild is false. |
KubernetesConfiguration
| Attribute | Type | Description |
|---|
| deploymentName | String | Name of the deployment. |
| manifestsToDeploy | List<String> | Manifests to deploy. |
| blueGreenManifests | List<String> | Blue green manifests. |
| canaryManifests | List<String> | Canary manifests. |
| abmanifests | List<String> | AB manifests. |
| helmConfiguration | HelmConfiguration | The helm configuration. See more info about the HelmConfiguration type below. |
HelmConfiguration
| Attribute | Type | Description |
|---|
| chart | String | Name of the chart. |
| releaseName | String | Name of the release. |
| parametersMap | List<ParameterMap> | All of the parameter mappings. See more info about the ParmaterMap type below. |
ParameterMap
| Attribute | Type | Description |
|---|
| key | String | Key for the parameter map. |
| value | String | Value for the parameter map. |
SCM Configuration Names by Type
| Tip |
|---|
All values not provided are defaulted. All defaults are configured from the Administration > Defaults page. |
| Expand |
|---|
| title | Subversion SCM Configuration Names |
|---|
|
| Attribute Name | Description |
|---|
MainScriptMain to a project in the | for the trunk within selected repository. | | BranchScript | Path 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. | TagScript | Path for the tag within the selected repository. Use ProjectVersion variable to specify identifier of current build. |
GetFolderScript| CheckoutFolderScript | Optional sub-folder to use for |
clone operation export/checkout operations during build workflow execution. |
|
| Expand |
|---|
| title | PVCS Git SCM Configuration Names |
|---|
|
| Attribute Name | Description |
|---|
ProjectPathScript| PromotionGroupScript | Promotion 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. | | BranchScript | Branch name to be used within selected repository. Use StreamName variable to identify branch name used at runtime. | LabelScript | Label script to be used when creating labels for the project in the repository. Use ProjectVersion variable to specify identifier of current build.Project 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. | | Path for the branches within selected repository. Use StreamName variable to identify branch name used at runtime. | | TagScript | Path 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. | | CheckoutFolderScript | Optional sub-folder to use for clone operation during build workflow execution. |
|
| Expand |
|---|
| title | PERF CVS SCM Configuration Names |
|---|
|
| Attribute Name | Description |
|---|
| MainScript | Main Path to a project in the selected repository. | | BranchScript | Branch name to be used within selected repository. Use ModuleNamesScript | Module 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. | | BranchNameScript | Path for the branches within selected repository. Use StreamName variable to identify branch name used at runtime. | | LabelNameScriptTagScript | Label Tag script to be used when creating labels tags for the project in the repository. Use ProjectVersion variable to specify identifier of current build. | | CheckoutFolderScript | Optional sub-folder to use for clone operation during build workflow execution. |
|
| Expand |
|---|
| title | CCUCM TFVC SCM Configuration Names |
|---|
|
| Attribute Name | Description |
|---|
| ProjectVobScript | Project versioned object base script. | | VobPathsScript | Script for versioned object base path. | | LabelNameScript | Label script to be used when creating labels for the MainScript | Main Path to a project in the repository. Use selected repository. | | BranchScript | Path 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. | | CheckoutFolderScriptGetFolderScript | Optional sub-folder to use for clone operation during build workflow execution.StreamScript | Script for stream. |
|
| Expand |
|---|
| title | FILE PVCS SCM Configuration Names |
|---|
|
|
Example
If the following project object exists,
| Code Block |
|---|
| theme | Eclipse |
|---|
| title | Existing Project |
|---|
|
{
"projectName": "Example Project",
"projectId": 10002,
"projectPath": "FlexDeploy/Testing/Example Project",
"description": null,
"isActive": true,
"partialDeployment": true,
"priority": 1,
"projectType": "EBS",
"priorityScope": "Application",
"applicationId": 14852,
"scmType": "GIT",
"mainStreamName": "master",
"streams": [73419],
"buildInfo": null,
"deployInfo": {
"instanceIds": [80524],
"workflowId": 34540
},
"utilityExecutionInfo": null,
"scmConfiguration": {
"sources": [
{
"instanceId": 16465,
"configValues": [
{
| Attribute Name | Description |
|---|
| MainFolderScriptProjectPathScript | Main Project Path to a project in the selected repository. | BranchFolderScript | Branch name to be used within selected repository. Use 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. | | PromotionGroupScript | Promotion Group name to be used. Use StreamName variable to identify branch Promotion Group name used at runtime. | | CheckoutFolderScript | Optional sub-folder to use for clone operation during build workflow execution. |
|
...
Response Codes
...
| UsingPGScript | Whether the Promotion Group script should be used to identify the stream. If false, then the branch script will be used. | | BranchScript | Branch name to be used within selected repository. Use StreamName variable to identify branch name used at runtime. | | LabelScript | Label script to be used when creating labels for the project in the repository. Use ProjectVersion variable to specify identifier of current build. | | CheckoutFolderScript | Optional sub-folder to use for clone operation during build workflow execution. |
|
| Expand |
|---|
| title | PERF SCM Configuration Names |
|---|
|
| Attribute Name | Description |
|---|
| MainScript | Main Path to a project in the selected repository. | | BranchScript | Branch name to be used 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. | | CheckoutFolderScript | Optional sub-folder to use for clone operation during build workflow execution. |
|
| Expand |
|---|
| title | CCUCM SCM Configuration Names |
|---|
|
| Attribute Name | Description |
|---|
| ProjectVobScript | Project versioned object base script. | | VobPathsScript | Script for versioned object base path. | | LabelNameScript | Label script to be used when creating labels for the project in the repository. Use ProjectVersion variable to specify identifier of current build. | | CheckoutFolderScript | Optional sub-folder to use for clone operation during build workflow execution. | | StreamScript | Script for stream. |
|
| Expand |
|---|
| title | FILE SCM Configuration Names |
|---|
|
| Attribute Name | Description |
|---|
| MainFolderScript | Main Path to a project in the selected repository. | | BranchFolderScript | Branch name to be used within selected repository. Use StreamName variable to identify branch name used at runtime. | | CheckoutFolderScript | Optional sub-folder to use for clone operation during build workflow execution. |
|
| Include Page |
|---|
| REST V1 Project Response |
|---|
| REST V1 Project Response |
|---|
|
Response Codes
| HTTP Code | Description |
|---|
| 200 | Projects were found and returned |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 500 | Unexpected internal server error |
Example
If the following project object exists,
| Code Block |
|---|
| theme | Eclipse |
|---|
| title | 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,
| Code Block |
|---|
| theme | Eclipse |
|---|
| title | 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:
| Code Block |
|---|
| theme | Eclipse |
|---|
| title | 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": {
"configNameinstanceIds": "SparseCheckoutFoldersScript"[80524],
"workflowId": 34540
},
"preDeployInfo": {
"configValue": "\"mainfolder/main\"" "workflowId": 42978
},
"scmConfiguration": {
} "sources": [
],{
"sourceNumberinstanceId": 116465,
}"configValues": [
] }
} |
and a PATCH request is sent to http://host:port/flexdeploy/rest/v1/project/10002 receiving the following JSON project object,
| Code Block |
|---|
| theme | Eclipse |
|---|
| title | PATCH Request JSON |
|---|
|
{ {
"projectPath "configName": "/FlexDeploy/REST/Example ProjectSparseCheckoutFoldersScript",
"description": "Project created with API", "partialDeployment": true, "priority": 2, "projectTypeconfigValue": "\"mainfolder/main\"EBS",
"mainStreamName": "master", "buildInfo": { "instanceId": 15925,}
"workflowId": 43164 }],
"scmConfiguration": { "sourcessourceNumber": [1
},
{
"instanceId": 42863,
"configValues": [
{
"configName": "SparseCheckoutFoldersScript",
"configValue": "\"EBS\""
}
],
"sourceNumber": 2
}
]
}
}
|
the following project object will then be patched in FlexDeploy:
| Code Block |
|---|
| theme | Eclipse |
|---|
| title | PATCH Response JSON |
|---|
|
{ "projectName": "Example Project", ]
},
"projectPathcontainerConfiguration": "/FlexDeploy/REST/Example Project", {,
"descriptiondockerfile": "Projectnew createddocker withfile API",name"
"isActivedockerStreams": true,[
"partialDeployment": true, {
"priority": 2, "projectType": "EBS", "priorityScopeisImageBuild": "Application"false,
"applicationId": 49628, "scmType": "GIT", "mainStreamNameisImagePush": "master"null,
"buildInfo": { "instanceIdstreamName": 15925"master",
"workflowId": 43164 }, "imageName": "new image name"deployInfo":
{ "instanceIds": [80524], }
"workflowId": 34540 ],
}, "scmConfigurationkubernetesConfiguration": {
{ "sourcesmanifestsToDeploy": [
{ "deploymanifest1"
"instanceId": 16465,
],
"configValuesblueGreenManifests": [
"bluegreenmanifest1"
{ ],
"configNamecanaryManifests": "SparseCheckoutFoldersScript",[
"canarymanifest1"
"configValue": "\"mainfolder/main\"" ],
"abmanifests": [
} ]"abmanifest1",
"sourceNumberabmanifest2":
1 },
{
],
"instanceIdhelmConfiguration": 42863,{
"configValuesparametersMap": [
{
"configNamekey": "SparseCheckoutFoldersScriptkey1",
"configValuevalueScript": "\"EBS\"new value"
}
],
"sourceNumber": 2"releaseName": "new release name",
"chart": "new chart name"
},
] "deploymentName": "new deployment name"
}
} |