Page Comparison

This PATCH service will update an existing project with the information passed through a JSON object. PATCH will only modify the attributes provided in input, and leave all other project attributes unchanged.

Info

title	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
projectId	URL	Id of the project to patch.
projectName	String	Unique name of the project.
applicationId	Long	Id of the application the project is in.
projectPath	String	Fully qualified project path.
isActive	Boolean	Boolean that tracks whether or not the project is active. Null input defaults to true.
description	String	Description of the project.
priority	Integer	Deploy priority of the project. Null input defaults to 1.
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, CCUCM, PVCS, FILE, or NONE.
priorityScope	String	This specifies the priority scope of the current project. Either Global, Folder, or Application. Null input defaults to Application.
buildInfo	ProjectBuildInfo	Build info for the project. See more info about the ProjectBuildInfo object below.
deployInfo	ProjectDeployInfo	Deploy info for the project. See more info about the ProjectDeployInfo object below.
utilityExecutionInfo	UtilityProjectExecutionInfo	Execution info for a utility project. See more info about the UtilityProjectExecutionInfo object below.
mainStreamName	String	Name of the main stream for the project. Null input defaults to master.
scmConfiguration	ProjectSCMPojo	SCM configuration for the project. See more info about the ProjectSCMPojo object below.

...

Expand

title	Subversion SCM Configuration Names

Attribute Name	Description
TrunkScript	Path for the trunk within selected repository.
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.
CheckoutFolderScript	Optional sub-folder to use for export/checkout operations during build workflow execution.

...

Expand

title	Git SCM Configuration Names

Attribute Name	Description
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.

Expand

title	CVS SCM Configuration Names

Attribute Name	Description
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.

Expand

title	TFVC 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

title	PVCS 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

title	PERF SCM Configuration Names

Attribute Name	Description
MainScript	Main Path to a project in the selected repository.
BranchScript	Branch name to be used within selected repository. Use StreamName variable to identify branch name used at runtime.
LabelNameScript	Label script to be used when creating labels for the project in the repository. Use ProjectVersion variable to specify identifier of current build.
CheckoutFolderScript	Optional sub-folder to use for clone operation during build workflow execution.

Expand

title	CCUCM SCM Configuration Names

Attribute Name	Description
ProjectVobScript	Project versioned object base script.
VobPathsScript	Script for versioned object base path.
LabelNameScript	Label script to be used when creating labels for the project in the repository. Use ProjectVersion variable to specify identifier of current build.
CheckoutFolderScript	Optional sub-folder to use for clone operation during build workflow execution.
StreamScript	Script for stream.

...

Expand

title	FILE SCM Configuration Names

Attribute Name	Description
MainFolderScript	Main Path to a project in the selected repository.
BranchFolderScript	Branch name to be used within selected repository. Use StreamName variable to identify branch name used at runtime.
CheckoutFolderScript	Optional sub-folder to use for clone operation during build workflow execution.

Include Page
REST V1 Project Response
REST V1 Project Response

...

Code Block

theme	Eclipse
title	Existing Project

{
    "projectName": "Example Project",
    "projectId": 10002,
    "projectPath": "FlexDeploy/Testing/Example Project",
    "description": null,
    "isActive": true,
    "partialDeployment": true,
    "priority": 1,
    "projectType": "EBS",
    "priorityScope": "Application",
    "applicationId": 14852,
    "scmType": "GIT",
    "mainStreamName": "trunkmaster",
    "streams": [73419],
    "buildInfo": null,
    "deployInfo": {
        "instanceIds": [80524],
        "workflowId": 34540
    },
    "utilityExecutionInfo": null,
    "scmConfiguration": {
        "sources": [
            {
                "instanceId": 16465,
                "configValues": [
                    {
                        "configName": "SparseCheckoutFolderScriptSparseCheckoutFoldersScript",
                        "configValue": "\"mainfolder/main\""
                    }
                ],
                "sourceNumber": 1
            }
        ]
    }
}

...

Code Block

theme	Eclipse
title	PATCH Request JSON

{
    "projectPath": "/FlexDeploy/REST/Example Project",
    "description": "Project created with API",
    "partialDeployment": true,
    "priority": 2,
    "projectType": "EBS",
    "mainStreamName": "master",
    "buildInfo": {
        "instanceId": 15925,
        "workflowId": 43164
    },
    "scmConfiguration": {
        "sources": [
            {
                "instanceId": 42863,
                "configValues": [
                    {
                        "configName": "SparseCheckoutFolderScriptSparseCheckoutFoldersScript",
                        "configValue": "\"EBS\""
                    }
                ],
                "sourceNumber": 2
            }
        ]
    }
}

...

Code Block

theme	Eclipse
title	PATCH Response JSON

{
    "projectName": "Example Project",
    "projectPath": "/FlexDeploy/REST/Example Project",
    "description": "Project created with API",
    "isActive": true,
    "partialDeployment": true,
    "priority": 2,
    "projectType": "EBS",
    "priorityScope": "Application",
    "applicationId": 49628,
    "scmType": "GIT",
    "mainStreamName": "master",
    "buildInfo": {
        "instanceId": 15925,
        "workflowId": 43164
    },
    "deployInfo": {
        "instanceIds": [80524],
        "workflowId": 34540
    },
    "scmConfiguration": {
        "sources": [
            {
                "instanceId": 16465,
                "configValues": [
                    {
                        "configName": "SparseCheckoutFolderScriptSparseCheckoutFoldersScript",
                        "configValue": "\"mainfolder/main\""
                    }
                ],
                "sourceNumber": 1
            },
			{
                "instanceId": 42863,
                "configValues": [
                    {
                        "configName": "SparseCheckoutFolderScriptSparseCheckoutFoldersScript",
                        "configValue": "\"EBS\""
                    }
                ],
                "sourceNumber": 2
            }
        ]
    }
}

...

Versions Compared

Old Version 7

New Version 8

Key

Request

Include Page
REST V1 Project Response
REST V1 Project Response

Page Comparison

Versions Compared

Old Version 7

New Version 8

Key

Request

Include PageREST V1 Project ResponseREST V1 Project Response

Include Page
REST V1 Project Response
REST V1 Project Response