Versions Compared

Old Version 8

changes.mady.by.user Chandresh Patel

Saved on

compared with

New Version Current

changes.mady.by.user Karl Henselin

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.

title
Info

API 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

projectName

Yes

String

Unique name of the project.

applicationId

No*

Long

Id of the application the project is in. 

*Either applicationId or projectPath is required

projectPath

No*

String

Fully qualified project path.

*Either applicationId or projectPath is required

isActive

No

Boolean

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

description

packageBuildType

No

String

Description of the project.partialDeployment

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

No

Boolean

String

Whether the project allows partial deployments. Null input defaults to false.

Description of the project.

projectClassification

Yes

String

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

priority

No

Integer

Deploy priority of the project. Default value is 1.

projectType

webhooksEnabled

No

* values are GENERAL, EBS, PARTIAL_FILE, PARTIAL_JDBC, OracleForms, ORACLE_DB, ORACLE_

ProjectTypeEnumType of project. Possible

Boolean

Whether or not webhooks are enabled. Null input defaults to false.

projectBuildSequence

No

Integer

Set the initial value for the ProjectBuildSequence variable which can be used in stream syntax scripts. Defaults to 1 if not passed.

projectType

No*

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

scmType

No

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.

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

priorityScope

No

String

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

buildInfo

No

ProjectBuildInfo

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

preDeployInfo

No

ProjectPreDeployInfo

PreDeploy info for the project. See more info about the ProjectPreDeployInfo object below.

deployInfo

No

ProjectDeployInfo

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

utilityExecutionInfo

No

UtilityProjectExecutionInfo

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

mainStreamName

No

String

Name of the main stream for the project. Defaults to master.

scmConfiguration

No

ProjectSCMPojo

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

...

containerConfiguration

Attribute

No

ContainerConfiguration

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

ProjectBuildInfo

Attribute

Required

Type

Description

buildWorkflowId

workflowId

Yes

Long

Id of the build workflow used by this project.

buildInstanceId

instanceId

Yes

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

Required

Type

Description

deployWorkflowId

workflowId

Yes

Long

Id of the deployment workflow used by this project.

deployInstanceIds

instanceIds

Yes

List<Long>

Id of each of the instances where the project can be deployed.

UtilityProjectExecutionInfo

Attribute

Required

Type

Description

utilityWorkflowId

workflowId

Yes

Long

Id of the utility workflow used by this project.

utilityInstanceIds

instanceIds

Yes

List<Long>

Id of each of the utility instance where this project can be run.

ProjectSCMPojo

Attribute

Required

Type

Description

sources

Yes

List<ProjectSCMConfig>

List of SCM configuration sources. See more info about the ProjectSCMConfig object below.

ProjectSCMConfig

Attribute

Required

Type

Description

instanceId

Yes

Long

SCM instance id for this source.

configValues

No

List<ProjectSCMConfigValue>

Configuration values for each SCM source. See more info about the ProjectSCMConfigValue object below.

sourceNumber

No

Integer

Number for the source. Source numbers start at 1 and increment for each source after that.

ProjectSCMConfigValue

Attribute

Required

Type

Description

configName

Yes

String

Name of the configuration attribute.

configValue

No

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.

...

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.

...

ContainerConfiguration

Attribute

Required

Type

Description

dockerFile

Yes

String

Name of the dockerfile

dockerStreams

Yes

List<DockerStream>

Information about the docker streams. See more info about the DockerStream type below.

kubernetesConfiguration

No

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.

isTagLatest

Boolean

If the image will be tagged as latest

registryAccount

String

The Docker Registry Account Code to push to.

imageScan

Boolean

If the image will be scanned with Anchore.

container

DockerStreamContainer

Container configuration during deployment

DockerStreamContainer

Attribute

Type

Description

runContainer

Boolean

Run a container with this image during deployment

containerName

String

Groovy Script of the container name to run

volumes

String

Groovy Script of the volumes to bind to the container

ports

Boolean

Groovy Script of the ports to bind to the container

additionalParams

Boolean

Groovy Script for any additional arguments to pass the run container command

KubernetesConfiguration

Attribute

Required

Type

Description

deploymentName

No

String

Name of the deployment.

manifestsToDeploy

No

List<String>

Manifests to deploy.

blueGreenManifests

No

List<String>

Blue green manifests.

canaryManifests

No

List<String>

Canary manifests.

abmanifests

No

List<String>

AB manifests.

helmConfiguration

Yes

HelmConfiguration

The helm configuration. See more info about the HelmConfiguration type below.

HelmsConfiguration

Attribute

Required

Type

Description

chart

Yes

String

Name of the chart.

releaseName

Yes

String

Name of the release.

parametersMap

No

List<ParameterMap>

All of the parameter mappings. See more info about the ParmaterMap type below.

ParameterMap

Attribute

Required

Type

Description

key

Yes

String

Key for the parameter map.

value

Yes

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
titleSubversion SCM Configuration Names


Attribute Name

Description

MainScript

TrunkScript

Main

Path

to a project in the

for the trunk within selected repository.

BranchScript

Branch name to be used

Path for the branches within selected repository.

Use StreamName Label script to be used when creating labels for the project in the repository. Use ProjectVersion variable

 Use StreamName variable to identify branch name used at runtime.

LabelNameScript

TagScript

Path 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. Use ProjectVersion
Expand
titleCCUCM Git SCM Configuration Names


 variable

Attribute Name

Description

ProjectVobScriptProject versioned object base script.
VobPathsScriptScript for versioned object base path.
LabelNameScript

BranchScript

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

.StreamScriptScript for stream

.



Branch name to be used within selected repository. Use StreamName variable
Expand
titleFILE CVS SCM Configuration Names


Attribute Name

Description

MainFolderScriptMain Path to a project in the selected repository.
BranchFolderScript

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.

TagScript

Tag script to be used when creating 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.

...

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 Name

Description

MainScript

Main Path to a project in the 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.

GetFolderScript

Optional sub-folder to use for clone operation during build workflow execution.



Expand
titlePVCS SCM Configuration Names


Attribute Name

Description

ProjectPathScript

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.

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.

CheckoutFolderScript

Optional sub-folder to use for clone operation during build workflow execution.



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

POST JSON
Code Block
{
    "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:

POST JSON
Code Block
{
    "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"
        }
    }
}