Project API

Projects can be accessed through this API using the GET service.

Authentication - Use Basic Authentication for this API.

Valid Source Control Management Types

Source Control Management SystemJSON String Representation
Concurrent Version System"CVS"
Git"GIT"
File System"FILE"
Perforce"PERF"
Polytron Version Control System"PVCS"
Subversion"SVN"
Team Foundation Version Control"TFVC"

Valid Project Types

Project TypeJSON String Representation
General"GENERAL"
Managed File Transfer"MFT"
Partial File"PARTIAL_FILE"
Oracle Forms"OracleForms"
Oracle Database"ORACLE_DB"
Oracle Business Intelligence"ORACLE_BI"
Sales Force"SALESFORCE"
Utility"UTILITY"
Generic"GENERIC"

Valid Priority Scope Types

Priority Scope TypesJSON String Representation
Application"Application"
Folder"Folder"
Global"Global"

Valid Project Classifications

Classification TypesJSON String Representation
Standard"Standard"
Partial Deployments"PartialDeployments"
Utility"Utility"
Container"Container"

GET

There are two implementations of GET. One will find a Project with the given Id and return the JSON representation of the Project. The other will find a list of Projects matching the parameters supplied to it.

GET (Using Id)

This GET service will find a Project by Id and return a JSON representation of it.

API URLs

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

Request

Parameter
Required
Type
Description
idYesURLThis is a URL path parameter for the id which is used to find a project.

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 we had a Project in our database with the id 10002, when we run a GET request at the following URL:

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

The GET request would return the  following JSON project object:

Project - "Project1"
{
    "priority": 1,
    "projectName": "XXHR",
    "projectId": 10002,
    "description": "EBS Customizations",
    "applicationId": 10011,
    "projectPath": "FlexDeploy/EBSCustomizations/HR/XXHR",
    "priorityScope": "Application",
    "projectClassification": "PartialDeployments",
    "isActive": true,
    "scmType": "GIT",
    "scmConfiguration": {
        "sources": [
            {
                "instanceId": 15551,
                "configValues": [
                    {
                        "configName": "BranchScript",
                        "configValue": "StreamName"
                    },
                    {
                        "configName": "TagScript",
                        "configValue": "ProjectVersion"
                    },
                    {
                        "configName": "SparseCheckoutFoldersScript",
                        "configValue": "\"EBSCustomizations/XXHR\""
                    },
                    {
                        "configName": "CheckoutFolderScript",
                        "configValue": "ProjectName"
                    }
                ],
                "sourceNumber": 1
            }
        ]
    },
    "streams": [
        10802,
        10803,
        10804,
        10805
    ],
    "mainStreamName": "master",
    "deployInfo": {
        "workflowId": 15529,
        "instanceIds": [
            11153,
            11168,
            11183,
            11198,
            11213,
            11228,
            11243
        ]
    },
    "buildInfo": {
        "workflowId": 10869,
        "instanceId": 11153
    },
   "preDeployInfo": {
        "workflowId": 42978
    },
    "utilityExecutionInfo": null,
    "projectType": "EBS",
	"packageBuildType": "BOTH",
	"webhooksEnabled": false,
	"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"
        }
	}
}

GET (Using Query Parameters)

This GET service will find a project by querying based on a name and application id and return the JSON representations of the objects. If no query parameters are given this request will return the entire list of projects.

API URLs

http://host:port/flexdeploy/rest/v1/project?
Append the following character sequences to the above URL to specify Query parameters. Use '&' between successive query parameters:

  • projectName={name}
  • applicationId={applicationid}
  • folderPath={folderPath}
  • isActive={isActive}

folderPath Format

  • Path parameters are separated by slashes(forward or backward).
  • Trailing slashes will be ignored.
  • Single leading slashes are ignored.
  • To access a folder or application, it's full path from the project archive root folder must be used.
  • A shorted path is valid, but will return more results.
  • The project archive root folder is an optional path parameter.
  • Folders and applications are considered path parameters.
  • Forward and backward slashes are accepted
  • Project names are not considered path parameters. For example,
    • The folderPath used to access the 'AccountingApps' application :
    • /Flexdeploy/CommerceProjects/AccountingApps/
      • or
    • CommerceProjects\AccountingApps
    • i.e. you can omit FlexDeploy at start of folderPath

Examples:

The query parameters are not case sensitive. Searching by projectName=NAME is the same as searching by projectName=name.

Request

Parameter
Required
Type
Description
projectNameNoQuery - String

This is a URL query parameter for the name which is used to query the projects with.

Contains ignore case search

applicationIdNoQuery - LongThis is a URL query parameter for application id which is used to query the projects within an application.
folderPathNoQuery - String

This is a URL query parameter which specified the path of the desired folders (and optionally the application, but not the project name)

All projects in provided path will be considered, i.e. including any sub folders of provided path as well.

isActiveNoQuery - Boolean

This is a URL query parameter which specifies whether returned projects should only include active or inactive projects.

If this parameter is not provided, both active and inactive projects may be returned.

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 Code
Description
200Search successful and results returned
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
500Unexpected internal server error

Example

If we had Projects in our database with the names 'Project1' and 'Project2' and the following attributes:

Project - "Project1"
{
   "priority": 1,
   "projectName": "Project1",
   "description": "Our thoughts become our words. Our words become our actions.",
   "applicationId": 10001,
   "priorityScope": "Application",
   "projectClassification": "Standard",
   "isActive": true,
   "scmType": "NONE",
   "streams": [
      10802,
      10803,
      10804,
      10805
   ],
   "utilityWorkflowId": 11434,
   "utilityInstanceIds": [11275],
   "deployWorkflowId": 10873,
   "deployInstanceIds": [
      11153,
      11168,
      11183,
      11198,
      11213,
      11228,
      11243
   ],
   "buildWorkflowId": 10869,
   "buildInstanceId": 11153,
   "projectType": null,
   "webhooksEnabled": false
}
Project - "Project2"
{
   "priority": 1,
   "description": "No Permissions",
   "applicationId": 10001,
   "isActive": true,
   "scmType": "SVN",
   "projectType": null,
   "projectName": "Project2",
   "streams": [],
   "priorityScope": "Application",
   "projectClassification": "Standard",
   "utilityWorkflowId": null,
   "utilityInstanceIds": null,
   "deployWorkflowId": null,
   "buildWorkflowId": null,
   "deployInstanceIds": null,
   "buildInstanceId": null,
   "webhooksEnabled": false
}

When we run a GET request at the following URL

http://host:port/flexdeploy/rest/v1/project?applicationId=10001

The GET request would return the  following JSON workflow object

{
   "priority": 1,
   "description": "No Permissions",
   "applicationId": 10001,
   "isActive": true,
   "scmType": "SVN",
   "projectType": null,
   "projectName": "Project2",
   "streams": [],
   "priorityScope": "Application",
   "projectClassification": "Standard",
   "utilityWorkflowId": null,
   "utilityInstanceIds": null,
   "deployWorkflowId": null,
   "buildWorkflowId": null,
   "deployInstanceIds": null,
   "buildInstanceId": null,
   "webhooksEnabled": false
}

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"
        }
}


POST

Create Project

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

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
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.
projectClassificationYesStringThe classification of the project, such as "Standard" or "PartialDeployments"
priorityNoIntegerDeploy priority of the project. Default value is 1.
webhooksEnabledNoBooleanWhether 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.
preDeployInfoNoProjectPreDeployInfo@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
workflowIdYesLongId of the build workflow used by this project.
instanceIdYesLongId 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

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

UtilityProjectExecutionInfo

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

ProjectSCMPojo

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

ProjectSCMConfig

AttributeRequiredTypeDescription
instanceIdYesLongSCM instance id for this source.
configValuesNoList<ProjectSCMConfigValue>Configuration values for each SCM source. See more info about the ProjectSCMConfigValue object below.
sourceNumberNoIntegerNumber for the source. Source numbers start at 1 and increment for each source after that.

ProjectSCMConfigValue

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

ContainerConfiguration

AttributeRequiredTypeDescription
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

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

POST 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:

POST 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": 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"
        }
    }
}

Build Project (Using Id)

This POST service will perform the same action found on the Build Request Form. It will initiate a request to build the project with the given Id. The service will return workflow request. Workflow request id from return data can be used with Workflow Request API to determine when the execution is complete.

This page includes examples for Full and Partial deploy project builds.

API URLs

http://host:port/flexdeploy/rest/v1/project/(Id)/build

Request

  • If trying to build a Partial Deploy project with all of the files in the repository (equivalent to Build - All Files button in the UI), then simply remove the "projectFiles" list, and the REST API will detect that the project is meant for partial deploys automatically and perform the build with all of the files.

Parameter

Required

Type

Description

environmentIdY

Long

This is the environment Id, not the environment name that you see on most screens.

streamId

Y

Long

The Id of the Stream.

forceBuild

N

Boolean

Values are true or false. Indicates that the build should occur even if there are not SCM changes. Defaults to false.

relatedTicketsNStringList of Issue Tracking System tickets.
workflowVersionOverride

N

String

Optionally the version of the workflow can be overridden. Defaults to the currently active version.

inputs

N

List<Input>

See Common Parameters below.

flexFieldsNList<FlexField>See Common Parameters below.
projectFilesNList<ProjectFile>

Only for partial deployment project builds.

An array of objects with 2 fields each: path and scmRevision.

packageNameNString

Only for partial deployment project builds.

Unique name to identify a build for partial deployments project. Defaults to the project version if no value is provided.

If packageName is provided without projectFiles, files configured in that package will be used.

If packageName is provided with projectFiles, then input is used for build and package definition is updated with this projectFiles list.

If packageName and projectFiles are not provided for partial deployment project, then All Files build will be performed.

releaseIdNStringId of the release to which this build is related to. If specified, a new snapshot is going to be created.

Input

This is a list of code/value pairs for the inputs. Not all inputs need to be supplied. If an input has a default value that is acceptable for the Workflow to run, it does not need to be supplied.

Attribute
RequiredType
Description
codeYStringThe code of the Input
valueNString

The value of the Input

FlexField

This is a list of the code/value pairs for the FlexFields (not the Display Name). Not all FlexFields need to be supplied. If a FlexField has a default value or options that are acceptable for the workflow to run, it does not need to be changed.

Attribute
RequiredType
Description
codeYStringThe code of the FlexField
valueNString

The value of the FlexField

ProjectFile

Attribute
RequiredType
Description
pathYStringFully qualified file path that is required inside the projectFiles parameter.
scmRevisionNLong

Optionally include the revision number that you would like to use for the build.

If it is not indicated, then FlexDeploy will use the latest revision as the default.

Response

Attributes

Type

Description

warningMessageString

Indicates any warning message in the event where the request was successful but no build was initiated.  

For example: No changes found in source control

warningCodeStringMatching warning code for the warning message.  

workflowRequests

Array

Array of workflow request objects

Response Codes

HTTP Code
Description
200No changes were detected, no build initiated.
201Project was built successfully
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
404Project not found
500Unexpected internal server error

Example

We can build a Project with Id 10004 with this request:

API URLs

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

Sample JSON Request

{
    "environmentId": 11101 ,
    "forceBuild": true,
    "workflowVersionOverride": null,
    "streamId": 11210,
    "inputs": [
    {
        "code":"input1","value": "xyz"
    },
    {
        "code":"input2","value": "123"
    }],
    "projectFiles":[
    {
        "path": "/java/xxt/oracle/xxPersonMainCO.java"
    },
    {
       "path": "/java/xxt/oracle/apps/managePersonCO.java",
       "scmRevision": "1515"
    }],
    "packageName": "ALM150",
    "relatedTickets": null,
    "flexFields": [{
        "code": "Build FlexField" ,
        "value": 10
    }],
    "releaseId": 27003
}

In response, we will receive an array of workflowRequests

{
    "warningMessage": null,
    "warningCode": null,
    "workflowRequests": [
        {
            "packageName": null,
            "folderName": "Human Resources",
            "releaseSnapshotId": null,
            "workflowRequestStatus": "READY",
            "folderId": 10001,
            "exceptionToWindow": false,
            "releaseDefinitionId": null,
            "cmsissues": "",
            "workflowRequestId": 12019,
            "projectName": "ProcessHRRequest",
            "projectStreamId": 10502,
            "projectVersionName": "1.0.9",
            "requestAllFiles": false,
            "projectVersionId": 30001,
            "environmentId": 11016,
            "folderRequestId": null,
            "flexFields": [],
            "folderPath": "FlexDeploy/Human Resources",
            "projectId": 10501,
            "requestedBy": "fdadmin",
            "requestedStartTime": null,
            "force": false,
            "stopOnPackageError": null,
            "workflowOverrideVersion": null,
            "folderVersionId": null
        }
    ]
}

Deploy Project (Using Id)

This POST service will perform the same action found on the Deployment Request Form off the project screen. It will initiate a request to deploy the project specified with the project Id. The service will return workflow request. Workflow request id from return data can be used with Workflow Request API to determine when the execution is complete.

API URL

http://host:port/flexdeploy/rest/v1/project/{Id}/deploy

Request

ParameterRequiredTypeDescription
environmentIdYLongThis is the environment id, not the environment name that is seen on most screens.
instanceIdsNArray of Long

The list of instances where the deployment will occur. Make sure to enter the instance id, not the instance name that is seen on most screens.

If not provided, all deploy instances configured for Project will be used for deployment.

projectIdYLongThe Id of the project to deploy.
packageDetailsN*Array of PackageInfo

This is required for partial deployments, but not for full deployments.

Included to indicate what should be deployed in a partial deployment.

See more info on PackageInfo below.

forceDeployNBooleanValues are true or false. Indicates that the deployment should occur even when the projectVersionId is already deployed to that instance. Defaults to false.
exceptionToWindowNBooleanValues are true or false. Indicates that the deployment is an exception to the deployment window. Defaults to false.
projectVersionIdNLongThe id of the project version to be deployed. If not specified, the most recently built projectVersionId will be deployed.
startTimeNString

The time when the deployment will be started. Format should yyyy-MM-dd'T'HH:mm:ssXXX.

For example, 2019-03-16T21:17:52-06:00

workflowVersionOverrideNStringOptionally, the version of the workflow can be overridden.
inputs NArraySee Common Parameters below.
flexFieldsNArraySee Common Parameters below.
changeTicketsNArray of StringTicket number for the given deployment, using the configured Change Management System.

Input

This is a list of code/value pairs for the workflow inputs. Not all inputs need to be supplied. If an input has a default value that is acceptable for the workflow to run, it does not need to be supplied.

AttributeRequiredTypeDescription
codeYStringThe code of the input
valueNStringThe value of the input

FlexField

This is the list of the code/value pairs for the FlexFields (not the display name). Not all FlexFields need to be supplied. If a FlexFields has a default value or options that are acceptable for the workflow to run, it does not need to be changed.

AttributeRequiredTypeDescription
codeYStringThe code of the FlexField
valueNStringThe value of the FlexField

PackageInfo

AttributeRequiredTypeDescription
packageNameNStringThe name of the package to deploy. If blank, all files will be assumed.
priorityNIntegerThe priority of the package. If it is not indicated, then FlexDeploy will deploy the packages in the order they are provided in the JSON request.
projectVersionIdY*LongThe id of the project version to deploy. This parameter is not required if useLatestPackageVersion is true.
useLatestPackageVersionNBooleanUses the most recent package version. Defaults to false.

Response

AttributeTypeDescription
warningMessageString

Indicates any warning message in the event where the request was successful but no new deployment was initiated.  

For example: Project Version is already deployed and force deploy wasn't specified

warningCodeStringMatching warning code for the warning message.  
workflowRequestsArray

Array of workflow request objects

Response Codes

HTTP CodeDescription
200Project version already deployed
201Deploy request initiated successfully
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
404Project not found
500Unexpected internal server error

Example Deploy Request

We can deploy a project with Id 10004 with the following request:

API URLs

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

{
	"instanceIds":[100001],
	"environmentId":12345,
	"forceDeploy":"false",
	"inputs":
	[
		{
			"code":"RESTART_SEVER",
			"value":"true"
		},
		{
			"code":"COMMENT",
			"value":"Deploying from REST API"
		}
	]
}

In response, we will receive an array of workflowRequests:

{
    "warningMessage": null,
    "warningCode": null,
    "workflowRequests": [
        {
            "packageName": null,
            "folderName": "Human Resources",
            "releaseSnapshotId": null,
            "workflowRequestStatus": "READY",
            "folderId": 10001,
            "exceptionToWindow": false,
            "releaseDefinitionId": null,
            "cmsissues": "",
            "workflowRequestId": 12001,
            "projectName": "ProcessHRRequest",
            "projectStreamId": 10502,
            "projectVersionName": "1.0.8",
            "requestAllFiles": false,
            "projectVersionId": 29201,
            "environmentId": 11210,
            "folderRequestId": null,
            "flexFields": [],
            "folderPath": "FlexDeploy/Human Resources",
            "projectId": 10501,
            "requestedBy": "fdadmin",
            "requestedStartTime": null,
            "force": true,
            "stopOnPackageError": null,
            "workflowOverrideVersion": null,
            "folderVersionId": null
        }
    ]
}

Execute Utility Project (Using Id)

This POST service will perform the same action found on the Execute Utility Project Request Form off the project screen. It will initiate a request to execute the project with the Project ID specified in the URL. The service will return workflow request. Workflow request id from return data can be used with Workflow Request API to determine when the execution is complete.

API URLs

http://host:port/flexdeploy/rest/v1/project/{id}/execute

Request

Attributes

Required

Type

Description

idYURLThis is a URL path parameter for the id which is used to execute a project.

environmentId

Y

Long

The Id of the Environment the project should be executed in.

instanceIds

N

List<Long>

A list of Instance Ids that the project should be executed on. If not supplied, the project will execute on the instances that are associated to the utility project.

exceptionToWindow

N

Boolean

Values are true or false. Indicates that the deployment is an exception to the deployment window. Defaults to false.

startTime

N

DateTime

The time when the deployment will be started. The expected time format is: yyyy-MM-dd'T'HH:mm:ssXXX

workflowVersionOverride

N

String

Optionally, specify a workflow version to override the active workflow version.

inputs

N

Array

This is a list of code/value pairs for the inputs. Not all inputs need to be supplied. If an input has a default value that is acceptable for the Workflow to run, it does not need to be supplied.

flexFields

N

Array

This is a list of the code/value pairs for the Flexfields. Not all FlexFields need to be supplied. If a FlexField has a default value or options that are acceptable for the workflow to run, it does not need to be changed.

Response

Attributes

Type

Description

warningMessageString

Indicates any warning message in the event where the request was successful but no execution was initiated.  

warningCodeStringMatching warning code for the warning message.  

workflowRequests

Array

Array of workflow request objects

Response Codes

HTTP CodeDescription
201Project was found and executed
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
500Unexpected internal server error

Example

We can execute a Utility Project with Id 10004 with this request:

URL: http://host:port/flexdeploy/rest/v1/project/10004/execute

{
	"environmentId":10045,
	"instanceIds":[10044],
	"exceptionToWindow":false,
	"startTime":"2018-07-20T11:31:06Z",
	"workflowVersionOverride":"1.0",
	"inputs":[
		{"code":"INPUT1","value":"Test"},
		{"code":"INPUT2","value":"1234"}
	],
	"flexFields":[
		{"code":"FLEXFIELD1","value":"123"},
		{"code":"FLEXFIELD2","value":"abc"}
	]
}

In response, we will receive an array of workflowRequests:

{
    "warningCode": null,
    "warningMessage": null,
    "wfrequests": [
        {
            "packageName": null,
            "workflowOverrideVersion": null,
            "stopOnPackageError": null,
            "workflowRequestStatus": "READY",
            "exceptionToWindow": false,
            "projectName": "Util",
            "workflowRequestId": 11819,
            "requestAllFiles": false,
            "projectStreamId": 29802,
            "projectVersionName": "1.0.1",
            "projectVersionId": 29809,
            "environmentId": 11210,
            "folderRequestId": null,
            "folderPath": "FlexDeploy/HR Utils",
            "flexFields": [],
            "projectId": 29801,
            "folderId": 10001,
            "requestedStartTime": null,
            "folderVersionId": null,
            "folderName": "HR Utils",
            "requestedBy": "fdadmin",
            "releaseDefinitionId": null,
            "cmsissues": "",
            "force": true,
            "releaseSnapshotId": null
        }
    ]
}

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