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 | ||
|---|---|---|
| ||
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. |
...
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
}
]
}
} |
...