Versions Compared

Old Version 8

changes.mady.by.user Chandresh Patel

Saved on

compared with

New Version Current

changes.mady.by.user Joel Wenzel

Saved on

Key

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

This POST service will create a new project with the same attributes as the given JSON object.

Info
titleAPI URLs

http://host:port/flexdeploy/rest/v1/project

Request

POST 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
Required
Type
Description
projectNameYesStringUnique name of the project.
applicationIdNo*Long

Id of the application the project is in. 

*Either applicationId or projectPath is required

projectPathNo*String

Fully qualified project path.

*Either applicationId or projectPath is required

isActiveNoBooleanBoolean that tracks whether or not the project is active. Null input defaults to true.
packageBuildTypeNoStringString 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.
descriptionNoStringDescription of the project.
partialDeploymentprojectClassificationNoYesBooleanStringWhether the project allows partial deployments. Null input defaults to false.The classification of the project, such as "Standard" or "PartialDeployments"
priorityNoIntegerDeploy priority of the project. Default value is 1.
projectTypewebhooksEnabledNo*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.

*Required for partial deployment projects

scmTypeNoSCMTypeEnumThis 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, BooleanWhether or not webhooks are enabled. Null input defaults to false.
projectBuildSequenceNoInteger@since 5.4.0.2 Set the initial value for the ProjectBuildSequence variable which can be used in stream syntax scripts. Defaults to 1 if not passed.
projectTypeNo*ProjectTypeEnum

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

*Required for partial deployment projects

scmTypeNoSCMTypeEnum

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.

Note: If scmType is specified, at least one SCM source must be provided.

priorityScopeNoStringThis specifies the priority scope of the current project. Either Global, Folder, or Application. Defaults to Application.
buildInfoNoProjectBuildInfoBuild info for the project. See more info about the ProjectBuildInfo object below.
deployInfopreDeployInfoNoProjectDeployInfoDeploy info for the project. ProjectPreDeployInfo@since 5.5.0.0 PreDeploy info for the project. See more info about the ProjectPreDeployInfo object below.
deployInfoNoProjectDeployInfoDeploy info for the project. See more info about the ProjectDeployInfo object below.
utilityExecutionInfoNoUtilityProjectExecutionInfoExecution info for a utility project. See more info about the UtilityProjectExecutionInfo object below.
mainStreamNameNoStringName of the main stream for the project. Defaults to master.
scmConfigurationNoProjectSCMPojoSCM configuration for the project. See more info about the ProjectSCMPojo object below.
containerConfigurationNoContainerConfigurationContainer configuration for the project. See more info about the ContainerConfiguration type below.

ProjectBuildInfo

AttributeRequiredTypeDescription
buildWorkflowIdworkflowIdYesLongId of the build workflow used by this project.
buildInstanceIdinstanceIdYesLongId of the instance where this project is built.

ProjectDeployInfoProjectPreDeployInfo

AttributeRequiredTypeDescription
deployWorkflowIdworkflowIdYesLong

Id of the

deployment

predeployment workflow used by this project.

deployInstanceIdsYes

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

ProjectDeployInfo

AttributeRequiredTypeDescription
workflowIdYesLongId of the deployment workflow used by this project.
instanceIdsYesList<Long>Id of each of the instances where the project can be deployed.

...

AttributeRequiredTypeDescription
utilityWorkflowIdworkflowIdYesLongId of the utility workflow used by this project.
utilityInstanceIdsinstanceIdsYesList<Long>Id of each of the utility instance where this project can be run.

...

AttributeRequiredTypeDescription
configNameYesStringName of the configuration attribute.
configValueNoStringValue of the configuration attribute.

...

ContainerConfiguration

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

...

titleTFVC SCM Configuration Names

...

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

...

titlePVCS SCM Configuration Names

...

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

...

titlePERF SCM Configuration Names

...

Description
dockerFileYesStringName of the dockerfile
dockerStreamsYesList<DockerStream>Information about the docker streams. See more info about the DockerStream type below.
kubernetesConfigurationNoKubernetesConfigurationConfiguration 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

AttributeRequiredTypeDescription
deploymentNameNoStringName of the deployment.
manifestsToDeployNoList<String>Manifests to deploy.
blueGreenManifestsNoList<String>Blue green manifests.
canaryManifestsNoList<String>

Canary manifests.

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

HelmsConfiguration

AttributeRequiredTypeDescription
chartYesStringName of the chart.
releaseNameYesStringName of the release.
parametersMapNoList<ParameterMap>All of the parameter mappings. See more info about the ParmaterMap type below.

ParameterMap

AttributeRequiredTypeDescription
keyYesStringKey for the parameter map.
valueYesStringValue 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
TrunkScriptPath 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.
CheckoutFolderScript

Optional sub-folder to use for

clone operation

export/checkout operations during build workflow execution.



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


Attribute NameDescription
ProjectVobScriptProject versioned object base script.
VobPathsScriptScript for versioned object base path.
LabelNameScript
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.
StreamScriptScript for stream.



Expand
titleFILE CVS SCM Configuration Names


Branch name to be used
Attribute NameDescription
MainFolderScriptMain Path to a project in the selected repository.
BranchFolderScriptModuleNamesScriptModule 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.
CheckoutFolderScriptOptional sub-folder to use for clone operation during build 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.

...

Response Codes

...



Example

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

{ "projectName": "Example Project", "projectPath": "FlexDeploy/Testing/Example Project", "description": "Project created with API", "partialDeployment": true, "priority": 2, "projectType": "EBS", "scmType": "GIT", "mainStreamName": "master", "buildInfo": {
Code Block
themeEclipse
titlePOST JSON
Expand
titleTFVC 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.



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



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 a POST request is sent to http://host:port/flexdeploy/rest/v1/project receiving the following JSON project object, 

Code Block
themeEclipse
titlePOST JSON
{
    "projectName": "Example Project",
    "projectPath": "FlexDeploy/Testing/Example Project",
    "description": "Project created with API",
    "projectClassification": "Standard",
    "priority": 2,
    "projectType": "EBS",
    "scmType": "GIT",
    "mainStreamName": "master",
	"webhooksEnabled": true,
    "buildInfo": {
        "instanceId": 15925,
        "workflowId": 43164
    },
    "deployInfo": {
        "instanceIds": [80524, 93048],
        "workflowId": 34540
    },
   "preDeployInfo": {
        "workflowId": 42978
    },
    "scmConfiguration": {
        "sources": [
            {
                "instanceId": 16465,
                "configValues": [
                    {
                        "configName": "SparseCheckoutFoldersScript",
                        "configValue": "\"mainfolder/main\""
                    }
                ],
                "sourceNumber": 1
            },
			{
                "instanceId": 46947,
                "configValues": [
                    {
                        "configName": "SparseCheckoutFoldersScript",
                        "configValue": "\"EBS\""
                    }
                ],
                "sourceNumber": 2
            }
        ]
    },
	"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"
        }
    }
}

the following project object will then be created in FlexDeploy:

Code Block
themeEclipse
titlePOST JSON
{
    "projectName": "Example Project",
	"projectId": 10002,
    "projectPath": "FlexDeploy/Testing/Example Project",
    "description": "Project created with API",
    "isActive": true,
    "projectClassification": "Standard",
    "priority": 2,
    "projectType": "EBS",
    "priorityScope": "Application",
    "applicationId": 14852,
    "scmType": "GIT",
    "mainStreamName": "master",
	"webhooksEnabled": true,
	"streams": [73419],
    "buildInfo": {
        "instanceId": 15925,
        "workflowId": 43164
    },
    "deployInfo": {
        "instanceIds": [80524, 93048],
        "workflowId": 34540
    },
    "preDeployInfo": {
        "workflowId": 42978
    },
	"utilityExecutionInfo": null,
    "scmConfiguration": {
        "sources": [
            {
                "instanceId": 1592516465,

       "workflowId": 43164     },     "deployInfoconfigValues": {[
        "instanceIds": [80524, 93048],         "workflowId": 34540{
    },     "scmConfiguration": {         "sources": [    "configName": "SparseCheckoutFoldersScript",
       {                 "instanceIdconfigValue": 16465,"\"mainfolder/main\""
                "configValues": [    }
                {],
                "sourceNumber": 1
      "configName": "SparseCheckoutFoldersScript",       },
			{
                "configValueinstanceId": "\"mainfolder/main\"" 46947,
                "configValues": [
     }               {
 ],                 "sourceNumber": 1     "configName": "SparseCheckoutFoldersScript",
      }, 			{                 "instanceIdconfigValue": 46947,"\"EBS\""
                    "configValues":}
[                ],
    {            "sourceNumber": 2
           "configName": "SparseCheckoutFoldersScript", }
        ]
    },
	"containerConfiguration": {
        "configValuedockerfile": "\"EBS\""docker file name"
        "dockerStreams": [
            {
}                "isImageBuild": ]true,
                "sourceNumberisImagePush": 2false,
            }    "streamName": "master",
   ]      } }

the following project object will then be created in FlexDeploy:

Code Block
themeEclipse
titlePOST JSON
{     "projectNamestreamId": 12345,
 "Example Project", 	"projectId": 10002,     "projectPath": "FlexDeploy/Testing/Example Project",     "descriptionimageName": "Projectimage createdname"
with API",     "isActive": true,     "partialDeployment": true,}
     "priority": 2,  ],
  "projectType": "EBS",     "priorityScopekubernetesConfiguration": "Application", {
      "applicationId": 14852,     "scmTypemanifestsToDeploy": "GIT", [
        "mainStreamName": "master", 	"streams": [73419],     "buildInfodeploymanifest1":
  {         "instanceId": 15925],
            "workflowIdblueGreenManifests": 43164[
       },     "deployInfo": {   "bluegreenmanifest1",
     "instanceIds": [80524, 93048],         "workflowIdbluegreenmanifest2":
  34540     }, 	"utilityExecutionInfo": null,   ],
 "scmConfiguration":  {         "sourcescanaryManifests": [
            {        "canarymanifest1"
        "instanceId": 16465,    ],
            "configValuesabmanifests": [
                "abmanifest1",
   {             "abmanifest2",
                "configNameabmanifest3":
"SparseCheckoutFoldersScript",            ],
            "configValuehelmConfiguration": "\"mainfolder/main\"" {
                "parametersMap": [
     }               {
 ],                 "sourceNumber": 1     "key": "key1",
      }, 			{                 "instanceIdvalueScript": 46947, "value1"
                   "configValues": [ },
                    {
                        "configNamekey": "SparseCheckoutFoldersScriptkey2",
                        "configValuevalueScript": "\value2"EBS\""
                    }
                ],
                "releaseName": "release name",
                "sourceNumberchart": 2"chart name"
            },
         ]   "deploymentName": "deployment name"
        }
    }
}