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. |
...
| Include Page | ||||
|---|---|---|---|---|
|
Response Codes
| HTTP Code | Description |
|---|---|
| 200 | Projects were found and returned |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 500 | Unexpected internal server error |
Example
If a POST request is sent to http://host:port/flexdeploy/rest/v1/project/10002 receiving the following JSON project object,
...