Project API Create
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 |
---|---|---|---|
projectName | Yes | String | Unique name of the project. |
applicationId | No* | Long | Id of the application the project is in. *Either applicationId or projectPath is required |
projectPath | No* | String | Fully qualified project path. *Either applicationId or projectPath is required |
isActive | No | Boolean | Boolean that tracks whether or not the project is active. Null input defaults to true. |
packageBuildType | No | String | String that defines usage of packages and build or deployments of packages. Possible values are ALL, PACKAGE, or BOTH. Defaults to Project Default or BOTH if Project Default is empty. |
description | No | String | Description of the project. |
projectClassification | Yes | String | The classification of the project, such as "Standard" or "PartialDeployments" |
priority | No | Integer | Deploy priority of the project. Default value is 1. |
webhooksEnabled | No | Boolean | Whether or not webhooks are enabled. Null input defaults to false. |
projectBuildSequence | No | Integer | Set the initial value for the ProjectBuildSequence variable which can be used in stream syntax scripts. Defaults to 1 if not passed. |
projectType | No* | ProjectTypeEnum | Type of project. Possible values are GENERAL, EBS, PARTIAL_FILE, PARTIAL_JDBC, OracleForms, ORACLE_DB, ORACLE_BI, ORACLE_APEX, MFT, SALESFORCE, MDS, or GENERIC. *Required for partial deployment projects |
scmType | No | SCMTypeEnum | This specifies the source control management system used by this project. Must be a valid source control management system. Possible values are SVN, GIT, CVS, TFVC, PERF, PVCS, FILE, or NONE. Note: If scmType is specified, at least one SCM source must be provided. |
priorityScope | No | String | This specifies the priority scope of the current project. Either Global, Folder, or Application. Defaults to Application. |
buildInfo | No | ProjectBuildInfo | Build info for the project. See more info about the ProjectBuildInfo object below. |
preDeployInfo | No | ProjectPreDeployInfo | PreDeploy info for the project. See more info about the ProjectPreDeployInfo object below. |
deployInfo | No | ProjectDeployInfo | Deploy info for the project. See more info about the ProjectDeployInfo object below. |
utilityExecutionInfo | No | UtilityProjectExecutionInfo | Execution info for a utility project. See more info about the UtilityProjectExecutionInfo object below. |
mainStreamName | No | String | Name of the main stream for the project. Defaults to master. |
scmConfiguration | No | ProjectSCMPojo | SCM configuration for the project. See more info about the ProjectSCMPojo object below. |
containerConfiguration | No | ContainerConfiguration | Container configuration for the project. See more info about the ContainerConfiguration type below. |
ProjectBuildInfo
Attribute | Required | Type | Description |
---|---|---|---|
workflowId | Yes | Long | Id of the build workflow used by this project. |
instanceId | Yes | Long | Id of the instance where this project is built. |
ProjectPreDeployInfo
Attribute | Required | Type | Description |
---|---|---|---|
workflowId | Yes | Long | Id of the predeployment workflow used by this project. Note - If predeploy workflow is used, then ProjectDeployInfo.instanceIds is needed |
ProjectDeployInfo
Attribute | Required | Type | Description |
---|---|---|---|
workflowId | Yes | Long | Id of the deployment workflow used by this project. |
instanceIds | Yes | List<Long> | Id of each of the instances where the project can be deployed. |
UtilityProjectExecutionInfo
Attribute | Required | Type | Description |
---|---|---|---|
workflowId | Yes | Long | Id of the utility workflow used by this project. |
instanceIds | Yes | List<Long> | Id of each of the utility instance where this project can be run. |
ProjectSCMPojo
Attribute | Required | Type | Description |
---|---|---|---|
sources | Yes | List<ProjectSCMConfig> | List of SCM configuration sources. See more info about the ProjectSCMConfig object below. |
ProjectSCMConfig
Attribute | Required | Type | Description |
---|---|---|---|
instanceId | Yes | Long | SCM instance id for this source. |
configValues | No | List<ProjectSCMConfigValue> | Configuration values for each SCM source. See more info about the ProjectSCMConfigValue object below. |
sourceNumber | No | Integer | Number for the source. Source numbers start at 1 and increment for each source after that. |
ProjectSCMConfigValue
Attribute | Required |
---|