Versions Compared

Old Version 10

changes.mady.by.user Hayden Mumm

Saved on

compared with

New Version 11

changes.mady.by.user Hayden Mumm

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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
titleAPI 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.
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.
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.
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
buildWorkflowIdLongId of the build workflow used by this project.
buildInstanceIdLongId of the instance where this project is built.

...

AttributeTypeDescription
configNameStringName of the configuration attribute.
configValueString

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.

...

titleSubversion SCM Configuration Names

...

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

...

titleGit 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. 

...

titleCVS 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

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

Tip

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


Label script to be used when creating labels for the project in the repository.
Expand
titleSubversion SCM Configuration Names


Attribute NameDescription
MainScript
TrunkScript
Main
Path
to a project in the
for the trunk within selected repository.
BranchScriptPath for the branches within selected repository. Use StreamName variable to identify branch name used at runtime.
LabelNameScript
TagScriptPath 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.



Promotion Group name to be used.  Use
Expand
titlePVCS Git SCM Configuration Names


Attribute NameDescription
ProjectPathScript
PromotionGroupScript
BranchScript
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
Promotion Group
branch name used at runtime.
UsingPGScriptBranchScriptBranch 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.
TagScript

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

Path for the tag within the selected repository. Use ProjectVersion variable to specify identifier of current build.
CheckoutFolderScriptOptional sub-folder to use for
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.



Expand
titlePERF CVS SCM Configuration Names


Branch name to be used
Attribute NameDescription
MainScriptMain Path to a project in the selected repository.
BranchScriptModuleNamesScriptModule 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.
LabelNameScriptTagScriptLabel

Tag script to be used when creating

labels

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.



Expand
titleCCUCM TFVC SCM Configuration Names


Script for versioned object base path
Attribute NameDescription
ProjectVobScriptProject versioned object base script.
VobPathsScriptMainScriptMain 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.

CheckoutFolderScriptGetFolderScriptOptional sub-folder to use for clone operation during build workflow execution.
StreamScriptScript for stream.



Expand
titleFILE PVCS SCM Configuration Names


Example

If the following project object exists,

Code Block
themeEclipse
titleExisting 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, "webhooksEnabled": false, "deployInfo": {
Attribute NameDescription
MainFolderScriptProjectPathScriptMain Project Path to a project in the selected repository.BranchFolderScriptBranch 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.
PromotionGroupScriptPromotion Group name to be used.  Use StreamName variable to identify branch Promotion Group name used at runtime.
CheckoutFolderScriptOptional 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.

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.



Expand
titlePERF 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.



Expand
titleCCUCM 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.



Expand
titleFILE 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.


Include Page
REST V1 Project Response
REST V1 Project Response

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,

Code Block
themeEclipse
titleExisting 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,
	"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
themeEclipse
titlePATCH Request JSON
{
    "projectPath": "/FlexDeploy/REST/Example Project",
    "description": "Project created with API",
    "partialDeployment": true,
    "priority": 2,
    "projectType": "EBS",
    "mainStreamName": "master",
	"webhooksEnabled": true,
    "buildInfo": {
        "instanceId": 15925,
        "workflowId": 43164
    },
    "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"
            },
            "instanceIdsdeploymentName": [80524],
 "new deployment name"
       "workflowId": 34540}
}

the following project object will then be patched in FlexDeploy:

Code Block
themeEclipse
titlePATCH Response JSON
{
  },     "utilityExecutionInfoprojectName": null"Example Project",
    "scmConfigurationprojectPath": {
"/FlexDeploy/REST/Example Project",
       "sourcesdescription": ["Project created with API",
    "isActive": true,
   { "partialDeployment": true,
    "priority": 2,
        "instanceIdprojectType": 16465,
           "EBS",
    "configValuespriorityScope": ["Application",
    "applicationId": 49628,
    "scmType": "GIT",
    "mainStreamName": "master",
	"webhooksEnabled": true,
{    "buildInfo": {
        "instanceId": 15925,
         "configNameworkflowId": "SparseCheckoutFoldersScript",43164
    },
    "deployInfo": {
        "instanceIds": [80524],
   "configValue": "\"mainfolder/main\""    "workflowId": 34540
    },
    "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
themeEclipse
titlePATCH Request JSON
{       "projectPath": "/FlexDeploy/REST/Example Project", {
   "description": "Project created with API",     "partialDeployment": true,     "priority": 2,     "projectTypeconfigName": "EBSSparseCheckoutFoldersScript",
     "mainStreamName                   "configValue": "\"mainfolder/main\"master",
	"webhooksEnabled": true,
           "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
themeEclipse
titlePATCH 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,
	"webhooksEnabled": true,     "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"
        }
}