This POST service will create a new project with the same attributes as the given JSON object.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/v1/project |
Request
POST will receive a project input JSON object and return a project JSON object. Project input JSON objects for the request can have the following attributes:
Parameter | Required | Type | Description |
|---|---|---|---|
| projectName | Yes | String | Unique name of the project. |
| applicationId | No* | Long | Id of the application the project is in. *Either applicationId or projectPath is required |
| projectPath | No* | String | Fully qualified project path. *Either applicationId or projectPath is required |
| isActive | No | Boolean | Boolean that tracks whether or not the project is active. Null input defaults to true. |
| description | No | String | Description of the project. |
| partialDeployment | No | Boolean | Whether the project allows partial deployments. Null input defaults to false. |
| priority | No | Integer | Deploy priority of the project. Default value is 1. |
| projectType | No* | ProjectTypeEnum | Type of project. Possible values are GENERAL, EBS, PARTIAL_FILE, PARTIAL_JDBC, OracleForms, ORACLE_DB, ORACLE_BI, ORACLE_APEX, MFT, SALESFORCE, UTILITY, MDS, or GENERIC. *Required for partial deployment projects |
| scmType | No | SCMTypeEnum | This specifies the source control management system used by this project. Must be a valid source control management system. Possible values are SVN, GIT, CVS, TFVC, PERF, CCUCM, PVCS, FILE, or NONE. ADD NOTE ABOUT MUST PROVIDE SCM INST IF THIS ISN"T NULL |
| 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. |
| 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. |
ProjectBuildInfo
| Attribute | Required | Type | Description |
|---|---|---|---|
| buildWorkflowId | Yes | Long | Id of the build workflow used by this project. |
| buildInstanceId | Yes | Long | Id of the instance where this project is built. |
ProjectDeployInfo
| Attribute | Required | Type | Description |
|---|---|---|---|
| deployWorkflowId | Yes | Long | Id of the deployment workflow used by this project. |
| deployInstanceIds | Yes | List<Long> | Id of each of the instances where the project can be deployed. |
UtilityProjectExecutionInfo
| Attribute | Required | Type | Description |
|---|---|---|---|
| utilityWorkflowId | Yes | Long | Id of the utility workflow used by this project. |
| utilityInstanceIds | Yes | List<Long> | Id of each of the utility instance where this project can be run. |
ProjectSCMPojo
| Attribute | Required | Type | Description |
|---|---|---|---|
| sources | Yes | List<ProjectSCMConfig> | List of SCM configuration sources. See more info about the ProjectSCMConfig object below. |
ProjectSCMConfig
| Attribute | Required | Type | Description |
|---|---|---|---|
| instanceId | Yes | Long | SCM instance id for this source. |
| configValues | No | List<ProjectSCMConfigValue> | Configuration values for each SCM source. See more info about the ProjectSCMConfigValue object below. |
| sourceNumber | No | Integer | Number for the source. Source numbers start at 1 and increment for each source after that. |
ProjectSCMConfigValue
| Attribute | Required | Type | Description |
|---|---|---|---|
| configName | Yes | String | Name of the configuration attribute. |
| configValue | No | String | Value of the configuration attribute. |
| Include Page | ||||
|---|---|---|---|---|
|
...
the following project object will then be created in FlexDeploy:
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"projectName": "Example Project",
"projectPath": "/FlexDeploy/Testing",
"description": "Project created with API",
"isActive": true,
"partialDeployment": true,
"priority": 1,
"projectType": "EBS",
"priorityScope": "Application",
"applicationId": 14852,
"scmType": "GIT",
"mainStreamName": "master",
"buildInfo": {
"instanceId": 15925,
"workflowId": 43164
},
"deployInfo": {
"instanceId": 80524,
"workflowId": 34540
},
"scmConfiguration": {
"sources": [
{
"instanceId": 16465,
"configValues": [
{
"configName": "SparseCheckoutFolderScript",
"configValue": "\"mainfolder/main\""
}
],
"sourceNumber": 1
}
]
}
} |
...