Project API
Projects can be accessed through this API using the GET service.
Authentication - Use Basic Authentication for this API.
Valid Source Control Management Types
Source Control Management System | JSON String Representation |
---|---|
Concurrent Version System | "CVS" |
Git | "GIT" |
File System | "FILE" |
Perforce | "PERF" |
Polytron Version Control System | "PVCS" |
Subversion | "SVN" |
Team Foundation Version Control | "TFVC" |
Valid Project Types
Project Type | JSON String Representation |
---|---|
General | "GENERAL" |
Managed File Transfer | "MFT" |
Partial File | "PARTIAL_FILE" |
Oracle Forms | "OracleForms" |
Oracle Database | "ORACLE_DB" |
Oracle Business Intelligence | "ORACLE_BI" |
Sales Force | "SALESFORCE" |
Utility | "UTILITY" |
Generic | "GENERIC" |
Valid Priority Scope Types
Priority Scope Types | JSON String Representation |
---|---|
Application | "Application" |
Folder | "Folder" |
Global | "Global" |
Valid Project Classifications
Classification Types | JSON String Representation |
---|---|
Standard | "Standard" |
Package Based (previously called Partial Deployments) | "PackageBased" |
Utility | "Utility" |
Container | "Container" |
GET
There are two implementations of GET. One will find a Project with the given Id and return the JSON representation of the Project. The other will find a list of Projects matching the parameters supplied to it.
GET (Using Id)
This GET service will find a Project by Id and return a JSON representation of it.
API URLs
http://host:port/flexdeploy/rest/v1/project/{id}
Request
Parameter | Required | Type | Description |
---|---|---|---|
id | Yes | URL | This is a URL path parameter for the id which is used to find a project. |
Response
Attribute | Type | Description |
---|---|---|
projectId | Long | Id of the project. |
projectName | String | Unique name of the project. |
folderId | String | Id of the folder 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. |
packageBuildType | 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 | String | Description of the project. |
projectClassification | String | The classification of the project, such as "Standard" or "PartialDeployments" |
priority | Integer | Deploy priority of the project. |
webhooksEnabled | Boolean | Whether or not webhooks are enabled. |
projectBuildSequence | Integer | The current value for the next ProjectBuildSequence number. |
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, PVCS, FILE, or NONE. |
priorityScope | String | This specifies the priority scope of the current project. Either Global, Folder, or Application. |
buildInfo | ProjectBuildInfo | Build info for the project. See more info about the ProjectBuildInfo object below. |
preDeployInfo | ProjectPreDeployInfo | PreDeploy info for the project. See more info about the ProjectPreDeployInfo 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. |
streams | List<Long> | List of ids which identify the project streams associated with this project. |
mainStreamName | String | Name of the main stream for the project. |
scmConfiguration | ProjectSCMPojo | SCM configuration for the project. See more info about the ProjectSCMPojo object below. |
containerConfiguration | ContainerConfiguration | Container configuration for the project. See more info about the ContainerConfiguration type below. |
links | List<Link> | List of any relevant links for the object. |
ProjectBuildInfo
Attribute | Type | Description |
---|---|---|
workflowId | Long | Id of the build workflow used by this project. |
instanceId | Long | Id of the instance where this project is built. |
ProjectPreDeployInfo
Attribute | Type | Description |
---|---|---|
workflowId | Long | Id of the predeployment workflow used by this project. Note - If predeploy workflow is used, then ProjectDeployInfo.instanceIds is needed |
ProjectDeployInfo
Attribute | Type | Description |
---|---|---|
workflowId | Long | Id of the deployment workflow used by this project. |
instanceIds | List<Long> | Id of each of the instances where the project can be deployed. |
UtilityProjectExecutionInfo
Attribute | Type | Description |
---|---|---|
workflowId | Long | Id of the utility workflow used by this project. |
instanceIds | List<Long> | Id of each of the utility instance where this project can be run. |
ProjectSCMPojo
Attribute | Type | Description |
---|---|---|
sources | List<ProjectSCMConfig> | List of SCM configuration sources. See more info about the ProjectSCMConfig object below. |
ProjectSCMConfig
Attribute | Type | Description |
---|---|---|
instanceId | Long | SCM instance id for this source. |
configValues | List<ProjectSCMConfigValue> | Configuration values for each SCM source. See more info about the ProjectSCMConfigValue object below. |
sourceNumber | Integer | Number for the source. Source numbers start at 1 and increment for each source after that. |
ProjectSCMConfigValue
Attribute | Type | Description |
---|---|---|
configName | String | Name of the configuration attribute. |
configValue | String | Value of the configuration attribute. |
ContainerConfiguration
Attribute | Type | Description |
---|---|---|
dockerFile | String | Name of the dockerfile |
dockerStreams | List<DockerStream> | Information about the docker streams. See more info about the DockerStream type below. |
kubernetesConfiguration | KubernetesConfiguration | Configuration for Kubernetes. See more info about the KubernetesConfiguration type below. |
DockerStream
Attribute | Type | Description |
---|---|---|
streamId | Long | Id of the stream. |
streamName | String | Name of the stream. |
imageName | String | Name of the image. |
isImageBuild | Boolean | If the image will build. |
isImagePush | Boolean | If the image will push. Null if isImageBuild is false. |
isTagLatest | Boolean | If the image will be tagged as latest |
registryAccount | String | The Docker Registry Account Code to push to. |
imageScan | Boolean | If the image will be scanned with Anchore. |
container | DockerStreamContainer | Container configuration during deployment |
DockerStreamContainer
Attribute | Type | Description |
---|---|---|
runContainer | Boolean | Run a container with this image during deployment |
containerName | String | Groovy Script of the container name to run |
volumes | String | Groovy Script of the volumes to bind to the container |
ports | Boolean | Groovy Script of the ports to bind to the container |
additionalParams | Boolean | Groovy Script for any additional arguments to pass the run container command |
KubernetesConfiguration
Attribute | Type | Description |
---|---|---|
deploymentName | String | Name of the deployment. |
manifestsToDeploy | List<String> | Manifests to deploy. |
blueGreenManifests | List<String> | Blue green manifests. |
canaryManifests | List<String> | Canary manifests. |
abmanifests | List<String> | AB manifests. |
helmConfiguration | HelmConfiguration | The helm configuration. See more info about the HelmConfiguration type below. |
HelmConfiguration
Attribute | Type | Description |
---|---|---|
chart | String | Name of the chart. |
releaseName | String | Name of the release. |
parametersMap | List<ParameterMap> | All of the parameter mappings. See more info about the ParmaterMap type below. |
ParameterMap
Attribute | Type | Description |
---|---|---|
key | String | Key for the parameter map. |
value | String | Value for the parameter map. |
Link
Attribute | Type | Description |
---|---|---|
type | String | Type of the link "REST", "UI" |
link | String | Physical link of the object. |
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 we had a Project in our database with the id 10002, when we run a GET request at the following URL:
http://host:port/flexdeploy/rest/v1/project/10002
The GET request would return the following JSON project object:
{ "priority": 1, "projectName": "XXHR", "projectId": 10002, "description": "EBS Customizations", "folderId": 10011, "projectPath": "FlexDeploy/EBSCustomizations/HR/XXHR", "priorityScope": "Application", "projectClassification": "PartialDeployments", "isActive": true, "scmType": "GIT", "scmConfiguration": { "sources": [ { "instanceId": 15551, "configValues": [ { "configName": "BranchScript", "configValue": "StreamName" }, { "configName": "TagScript", "configValue": "ProjectVersion" }, { "configName": "SparseCheckoutFoldersScript", "configValue": "\"EBSCustomizations/XXHR\"" }, { "configName": "CheckoutFolderScript", "configValue": "ProjectName" } ], "sourceNumber": 1 } ] }, "streams": [ 10802, 10803, 10804, 10805 ], "mainStreamName": "master", "deployInfo": { "workflowId": 15529, "instanceIds": [ 11153, 11168, 11183, 11198, 11213, 11228, 11243 ] }, "buildInfo": { "workflowId": 10869, "instanceId": 11153 }, "preDeployInfo": { "workflowId": 42978 }, "utilityExecutionInfo": null, "projectType": "EBS", "packageBuildType": "BOTH", "webhooksEnabled": false, "containerConfiguration": { "dockerfile": "docker file name" "dockerStreams": [ { "isImageBuild": true, "isImagePush": false, "streamName": "master", "streamId": 12345, "imageName": "image name" } ], "kubernetesConfiguration": { "manifestsToDeploy": [ "deploymanifest1" ], "blueGreenManifests": [ "bluegreenmanifest1", "bluegreenmanifest2" ], "canaryManifests": [ "canarymanifest1" ], "abmanifests": [ "abmanifest1", "abmanifest2", "abmanifest3" ], "helmConfiguration": { "parametersMap": [ { "key": "key1", "valueScript": "value1" }, { "key": "key2", "valueScript": "value2" } ], "releaseName": "release name", "chart": "chart name" }, "deploymentName": "deployment name" } } }
GET (Using Query Parameters)
This GET service will find a project by querying based on a name and application id and return the JSON representations of the objects. If no query parameters are given this request will return the entire list of projects.
API URLs
http://host:port/flexdeploy/rest/v1/project?
Append the following character sequences to the above URL to specify Query parameters. Use '&' between successive query parameters.
- projectName={name}
- folderId={folderId}
- isActive={isActive}
Examples:
- To search by name only: http://host:port/flexdeploy/rest/v1/project?projectName={name}
- To search by folder Id only: http://host:port/flexdeploy/rest/v1/project?folderId={folderId}
- To search for all active projects: http://host:port/flexdeploy/rest/v1/project?isActive=true
The query parameters are not case sensitive. Searching by projectName=NAME is the same as searching by projectName=name.
Request
Parameter | Required | Type | Description |
---|---|---|---|
projectName | No | Query - String | This is a URL query parameter for the name which is used to query the projects with. Contains ignore case search |
folderId | No | Query - String | This is a URL query parameter which specified the id of the desired folder and it's subfolders All projects in specific folder or all it's subfolders will be considered |
isActive | No | Query - Boolean | This is a URL query parameter which specifies whether returned projects should only include active or inactive projects. If this parameter is not provided, both active and inactive projects may be returned. |
Response
Attribute | Type | Description |
---|---|---|
projectId | Long | Id of the project. |
projectName | String | Unique name of the project. |
applicationId | String | 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. |
packageBuildType | 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 | String | Description of the project. |
projectClassification | String | The classification of the project, such as "Standard" or "PartialDeployments" |
priority | Integer | Deploy priority of the project. |
webhooksEnabled | Boolean | Whether or not webhooks are enabled. |
projectBuildSequence | Integer | The current value for the next ProjectBuildSequence number. |
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, PVCS, FILE, or NONE. |
priorityScope | String | This specifies the priority scope of the current project. Either Global, Folder, or Application. |
buildInfo | ProjectBuildInfo | Build info for the project. See more info about the ProjectBuildInfo object below. |
preDeployInfo | ProjectPreDeployInfo | PreDeploy info for the project. See more info about the ProjectPreDeployInfo 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. |
streams | List<Long> | List of ids which identify the project streams associated with this project. |
mainStreamName | String | Name of the main stream for the project. |
scmConfiguration | ProjectSCMPojo | SCM configuration for the project. See more info about the ProjectSCMPojo object below. |
containerConfiguration | ContainerConfiguration | Container configuration for the project. See more info about the ContainerConfiguration type below. |
links | List<Link> | List of any relevant links for the object. |
ProjectBuildInfo
Attribute | Type | Description |
---|---|---|
workflowId | Long | Id of the build workflow used by this project. |
instanceId | Long | Id of the instance where this project is built. |
ProjectPreDeployInfo
Attribute | Type | Description |
---|---|---|
workflowId | Long | Id of the predeployment workflow used by this project. Note - If predeploy workflow is used, then ProjectDeployInfo.instanceIds is needed |
ProjectDeployInfo
Attribute | Type | Description |
---|---|---|
workflowId | Long | Id of the deployment workflow used by this project. |
instanceIds | List<Long> | Id of each of the instances where the project can be deployed. |
UtilityProjectExecutionInfo
Attribute | Type | Description |
---|---|---|
workflowId | Long | Id of the utility workflow used by this project. |
instanceIds | List<Long> | Id of each of the utility instance where this project can be run. |
ProjectSCMPojo
Attribute | Type | Description |
---|---|---|
sources | List<ProjectSCMConfig> | List of SCM configuration sources. See more info about the ProjectSCMConfig object below. |
ProjectSCMConfig
Attribute | Type | Description |
---|---|---|
instanceId | Long | SCM instance id for this source. |
configValues | List<ProjectSCMConfigValue> | Configuration values for each SCM source. See more info about the ProjectSCMConfigValue object below. |
sourceNumber | Integer | Number for the source. Source numbers start at 1 and increment for each source after that. |
ProjectSCMConfigValue
Attribute | Type | Description |
---|---|---|
configName | String | Name of the configuration attribute. |
configValue | String | Value of the configuration attribute. |
ContainerConfiguration
Attribute | Type | Description |
---|---|---|
dockerFile | String | Name of the dockerfile |
dockerStreams | List<DockerStream> | Information about the docker streams. See more info about the DockerStream type below. |
kubernetesConfiguration | KubernetesConfiguration | Configuration for Kubernetes. See more info about the KubernetesConfiguration type below. |
DockerStream
Attribute | Type | Description |
---|---|---|
streamId | Long | Id of the stream. |
streamName | String | Name of the stream. |
imageName | String | Name of the image. |
isImageBuild | Boolean | If the image will build. |
isImagePush | Boolean | If the image will push. Null if isImageBuild is false. |
isTagLatest | Boolean | If the image will be tagged as latest |
registryAccount | String | The Docker Registry Account Code to push to. |
imageScan | Boolean | If the image will be scanned with Anchore. |
container | DockerStreamContainer | Container configuration during deployment |
DockerStreamContainer
Attribute | Type | Description |
---|---|---|
runContainer | Boolean | Run a container with this image during deployment |
containerName | String | Groovy Script of the container name to run |
volumes | String | Groovy Script of the volumes to bind to the container |
ports | Boolean | Groovy Script of the ports to bind to the container |
additionalParams | Boolean | Groovy Script for any additional arguments to pass the run container command |
KubernetesConfiguration
Attribute | Type | Description |
---|---|---|
deploymentName | String | Name of the deployment. |
manifestsToDeploy | List<String> | Manifests to deploy. |
blueGreenManifests | List<String> | Blue green manifests. |
canaryManifests | List<String> | Canary manifests. |
abmanifests | List<String> | AB manifests. |
helmConfiguration | HelmConfiguration | The helm configuration. See more info about the HelmConfiguration type below. |
HelmConfiguration
Attribute | Type | Description |
---|---|---|
chart | String | Name of the chart. |
releaseName | String | Name of the release. |
parametersMap | List<ParameterMap> | All of the parameter mappings. See more info about the ParmaterMap type below. |
ParameterMap
Attribute | Type | Description |
---|---|---|
key | String | Key for the parameter map. |
value | String | Value for the parameter map. |
Link
Attribute | Type | Description |
---|---|---|
type | String | Type of the link "REST", "UI" |
link | String | Physical link of the object. |
Response Codes
HTTP Code | Description |
---|---|
200 | Search successful and results returned |
400 | Bad request |
401 | Authentication failure |
403 | Authorization failure (no access to resource) |
500 | Unexpected internal server error |
Example
If we had Projects in our database with the names 'Project1' and 'Project2' and the following attributes:
{ "priority": 1, "projectName": "Project1", "description": "Our thoughts become our words. Our words become our actions.", "applicationId": 10001, "priorityScope": "Application", "projectClassification": "Standard", "isActive": true, "scmType": "NONE", "streams": [ 10802, 10803, 10804, 10805 ], "utilityWorkflowId": 11434, "utilityInstanceIds": [11275], "deployWorkflowId": 10873, "deployInstanceIds": [ 11153, 11168, 11183, 11198, 11213, 11228, 11243 ], "buildWorkflowId": 10869, "buildInstanceId": 11153, "projectType": null, "webhooksEnabled": false }
{ "priority": 1, "description": "No Permissions", "applicationId": 10001, "isActive": true, "scmType": "SVN", "projectType": null, "projectName": "Project2", "streams": [], "priorityScope": "Application", "projectClassification": "Standard", "utilityWorkflowId": null, "utilityInstanceIds": null, "deployWorkflowId": null, "buildWorkflowId": null, "deployInstanceIds": null, "buildInstanceId": null, "webhooksEnabled": false }
When we run a GET request at the following URL
http://host:port/flexdeploy/rest/v1/project?applicationId=10001
The GET request would return the following JSON workflow object
{ "priority": 1, "description": "No Permissions", "applicationId": 10001, "isActive": true, "scmType": "SVN", "projectType": null, "projectName": "Project2", "streams": [], "priorityScope": "Application", "projectClassification": "Standard", "utilityWorkflowId": null, "utilityInstanceIds": null, "deployWorkflowId": null, "buildWorkflowId": null, "deployInstanceIds": null, "buildInstanceId": null, "webhooksEnabled": false }
PATCH
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.
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. |
packageBuildType | 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 | String | Description of the project. |
priority | Integer | Deploy priority of the project. Null input defaults to 1. |
webhooksEnabled | Boolean | Whether or not webhooks are enabled. Null input defaults to false. |
projectBuildSequence | Integer | Update the value for the ProjectBuildSequence variable which can be used in stream syntax scripts. |
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, 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. |
preDeployInfo | ProjectPreDeployInfo | PreDeploy info for the project. See more info about the ProjectPreDeployInfo 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. |
contianerConfiguration | ContainerConfiguration | Container configuration for the project. See more info about the ContainerConfiguration type below. |
ProjectBuildInfo
Attribute | Type | Description |
---|---|---|
workflowId | Long | Id of the build workflow used by this project. |
instanceId | 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 | Type | Description |
---|---|---|
workflowId | Long | Id of the deployment workflow used by this project. |
instanceIds | List<Long> | Id of each of the instances where the project can be deployed. New instance ids will be added to the existing list of instance ids for deployment. |
UtilityProjectExecutionInfo
Attribute | Type | Description |
---|---|---|
workflowId | Long | Id of the utility workflow used by this project. |
instanceIds | List<Long> | Id of each of the utility instance where this project can be run. New instance ids will be added to the existing list of instance ids. |
ProjectSCMPojo
Attribute | Type | Description |
---|---|---|
sources | List<ProjectSCMConfig> | List of SCM configuration sources. See more info about the ProjectSCMConfig object below. |
ProjectSCMConfig
Attribute | Type | Description |
---|---|---|
instanceId | Long | SCM instance id for this source. |
configValues | List<ProjectSCMConfigValue> | Configuration values for each SCM source. See more info about the ProjectSCMConfigValue object below. |
sourceNumber | Integer | Number for the source. Source numbers start at 1 and increment for each source after that. |
ProjectSCMConfigValue
Attribute | Type | Description |
---|---|---|
configName | String | Name of the configuration attribute. |
configValue | String | Value of the configuration attribute. |
ContainerConfiguration
Attribute | Type | Description |
---|---|---|
dockerFile | String | Name of the dockerfile |
dockerStreams | List<DockerStream> | Information about the docker streams. See more info about the DockerStream type below. |
kubernetesConfiguration | KubernetesConfiguration | Configuration for Kubernetes. See more info about the KubernetesConfiguration type below. |
DockerStream
Attribute | Type | Description |
---|---|---|
streamId | Long | Id of the stream. |
streamName | String | Name of the stream. |
imageName | String | Name of the image. |
isImageBuild | Boolean | If the image will build. |
isImagePush | Boolean | If the image will push. Null if isImageBuild is false. |
KubernetesConfiguration
Attribute | Type | Description |
---|---|---|
deploymentName | String | Name of the deployment. |
manifestsToDeploy | List<String> | Manifests to deploy. |
blueGreenManifests | List<String> | Blue green manifests. |
canaryManifests | List<String> | Canary manifests. |
abmanifests | List<String> | AB manifests. |
helmConfiguration | HelmConfiguration | The helm configuration. See more info about the HelmConfiguration type below. |
HelmConfiguration
Attribute | Type | Description |
---|---|---|
chart | String | Name of the chart. |
releaseName | String | Name of the release. |
parametersMap | List<ParameterMap> | All of the parameter mappings. See more info about the ParmaterMap type below. |
ParameterMap
Attribute | Type | Description |
---|---|---|
key | String | Key for the parameter map. |
value | String | Value for the parameter map. |
SCM Configuration Names by Type
All values not provided are defaulted. All defaults are configured from the Administration > Defaults page.
Response
Attribute | Type | Description |
---|---|---|
projectId | Long | Id of the project. |
projectName | String | Unique name of the project. |
applicationId | String | 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. |
packageBuildType | 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 | String | Description of the project. |
projectClassification | String | The classification of the project, such as "Standard" or "PartialDeployments" |
priority | Integer | Deploy priority of the project. |
webhooksEnabled | Boolean | Whether or not webhooks are enabled. |
projectBuildSequence | Integer | The current value for the next ProjectBuildSequence number. |
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, PVCS, FILE, or NONE. |
priorityScope | String | This specifies the priority scope of the current project. Either Global, Folder, or Application. |
buildInfo | ProjectBuildInfo | Build info for the project. See more info about the ProjectBuildInfo object below. |
preDeployInfo | ProjectPreDeployInfo | PreDeploy info for the project. See more info about the ProjectPreDeployInfo 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. |
streams | List<Long> | List of ids which identify the project streams associated with this project. |
mainStreamName | String | Name of the main stream for the project. |
scmConfiguration | ProjectSCMPojo | SCM configuration for the project. See more info about the ProjectSCMPojo object below. |
containerConfiguration | ContainerConfiguration | Container configuration for the project. See more info about the ContainerConfiguration type below. |
links | List<Link> | List of any relevant links for the object. |
ProjectBuildInfo
Attribute | Type | Description |
---|---|---|
workflowId | Long | Id of the build workflow used by this project. |
instanceId | Long | Id of the instance where this project is built. |
ProjectPreDeployInfo
Attribute | Type | Description |
---|---|---|
workflowId | Long | Id of the predeployment workflow used by this project. Note - If predeploy workflow is used, then ProjectDeployInfo.instanceIds is needed |
ProjectDeployInfo
Attribute | Type | Description |
---|---|---|
workflowId | Long | Id of the deployment workflow used by this project. |
instanceIds | List<Long> | Id of each of the instances where the project can be deployed. |
UtilityProjectExecutionInfo
Attribute | Type | Description |
---|---|---|
workflowId | Long | Id of the utility workflow used by this project. |
instanceIds | List<Long> | Id of each of the utility instance where this project can be run. |
ProjectSCMPojo
Attribute | Type | Description |
---|---|---|
sources | List<ProjectSCMConfig> | List of SCM configuration sources. See more info about the ProjectSCMConfig object below. |
ProjectSCMConfig
Attribute | Type | Description |
---|---|---|
instanceId | Long | SCM instance id for this source. |
configValues | List<ProjectSCMConfigValue> | Configuration values for each SCM source. See more info about the ProjectSCMConfigValue object below. |
sourceNumber | Integer | Number for the source. Source numbers start at 1 and increment for each source after that. |
ProjectSCMConfigValue
Attribute | Type | Description |
---|---|---|
configName | String | Name of the configuration attribute. |
configValue | String | Value of the configuration attribute. |
ContainerConfiguration
Attribute | Type | Description |
---|---|---|
dockerFile | String | Name of the dockerfile |
dockerStreams | List<DockerStream> | Information about the docker streams. See more info about the DockerStream type below. |
kubernetesConfiguration | KubernetesConfiguration | Configuration for Kubernetes. See more info about the KubernetesConfiguration type below. |
DockerStream
Attribute | Type | Description |
---|---|---|
streamId | Long | Id of the stream. |
streamName | String | Name of the stream. |
imageName | String | Name of the image. |
isImageBuild | Boolean | If the image will build. |
isImagePush | Boolean | If the image will push. Null if isImageBuild is false. |
isTagLatest | Boolean | If the image will be tagged as latest |
registryAccount | String | The Docker Registry Account Code to push to. |
imageScan | Boolean | If the image will be scanned with Anchore. |
container | DockerStreamContainer | Container configuration during deployment |
DockerStreamContainer
Attribute | Type | Description |
---|---|---|
runContainer | Boolean | Run a container with this image during deployment |
containerName | String | Groovy Script of the container name to run |
volumes | String | Groovy Script of the volumes to bind to the container |
ports | Boolean | Groovy Script of the ports to bind to the container |
additionalParams | Boolean | Groovy Script for any additional arguments to pass the run container command |
KubernetesConfiguration
Attribute | Type | Description |
---|---|---|
deploymentName | String | Name of the deployment. |
manifestsToDeploy | List<String> | Manifests to deploy. |
blueGreenManifests | List<String> | Blue green manifests. |
canaryManifests | List<String> | Canary manifests. |
abmanifests | List<String> | AB manifests. |
helmConfiguration | HelmConfiguration | The helm configuration. See more info about the HelmConfiguration type below. |
HelmConfiguration
Attribute | Type | Description |
---|---|---|
chart | String | Name of the chart. |
releaseName | String | Name of the release. |
parametersMap | List<ParameterMap> | All of the parameter mappings. See more info about the ParmaterMap type below. |
ParameterMap
Attribute | Type | Description |
---|---|---|
key | String | Key for the parameter map. |
value | String | Value for the parameter map. |
Link
Attribute | Type | Description |
---|---|---|
type | String | Type of the link "REST", "UI" |
link | String | Physical link of the object. |
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 the following project object exists,
Existing Project
{ "projectName": "Example Project", "projectId": 10002, "projectPath": "FlexDeploy/Testing/Example Project", "description": null, "isActive": true, "projectClassification": "Container", "priority": 1, "priorityScope": "Application", "applicationId": 14852, "scmType": "GIT", "mainStreamName": "master", "streams": [73419], "buildInfo": null, "webhooksEnabled": false, "deployInfo": { "instanceIds": [80524], "workflowId": 34540 }, "utilityExecutionInfo": null, "scmConfiguration": { "sources": [ { "instanceId": 16465, "configValues": [ { "configName": "SparseCheckoutFoldersScript", "configValue": "\"mainfolder/main\"" } ], "sourceNumber": 1 } ] }, "containerConfiguration": {, "dockerfile": "docker file name" "dockerStreams": [ { "isImageBuild": true, "isImagePush": false, "streamName": "master", "streamId": 12345, "imageName": "image name" } ], "kubernetesConfiguration": { "manifestsToDeploy": [ "deploymanifest1" ], "blueGreenManifests": [ "bluegreenmanifest1", "bluegreenmanifest2" ], "canaryManifests": [ "canarymanifest1" ], "abmanifests": [ "abmanifest1", "abmanifest2", "abmanifest3" ], "helmConfiguration": { "parametersMap": [ { "key": "key1", "valueScript": "value1" }, { "key": "key2", "valueScript": "value2" } ], "releaseName": "release name", "chart": "chart name" }, "deploymentName": "deployment name" } }
and a PATCH request is sent to http://host:port/flexdeploy/rest/v1/project/10002 receiving the following JSON project object,
PATCH Request JSON
{ "projectPath": "/FlexDeploy/REST/Example Project", "description": "Project created with API", "priority": 2, "mainStreamName": "master", "webhooksEnabled": true, "buildInfo": { "instanceId": 15925, "workflowId": 43164 }, "preDeployInfo": { "workflowId": 42978 }, "scmConfiguration": { "sources": [ { "instanceId": 42863, "configValues": [ { "configName": "SparseCheckoutFoldersScript", "configValue": "\"EBS\"" } ], "sourceNumber": 2 } ] }, "containerConfiguration": {, "dockerfile": "new docker file name" "dockerStreams": [ { "isImageBuild": false, "isImagePush": null, "streamName": "master", "imageName": "new image name" } ], "kubernetesConfiguration": { "manifestsToDeploy": [ "deploymanifest1" ], "blueGreenManifests": [ "bluegreenmanifest1" ], "canaryManifests": [ "canarymanifest1" ], "abmanifests": [ "abmanifest1", "abmanifest2" ], "helmConfiguration": { "parametersMap": [ { "key": "key1", "valueScript": "new value" } ], "releaseName": "new release name", "chart": "new chart name" }, "deploymentName": "new deployment name" } }
the following project object will then be patched in FlexDeploy:
PATCH Response JSON
{ "projectName": "Example Project", "projectPath": "/FlexDeploy/REST/Example Project", "description": "Project created with API", "isActive": true, "projectClassification": "Container", "priority": 2, "priorityScope": "Application", "applicationId": 49628, "scmType": "GIT", "mainStreamName": "master", "webhooksEnabled": true, "buildInfo": { "instanceId": 15925, "workflowId": 43164 }, "deployInfo": { "instanceIds": [80524], "workflowId": 34540 }, "preDeployInfo": { "workflowId": 42978 }, "scmConfiguration": { "sources": [ { "instanceId": 16465, "configValues": [ { "configName": "SparseCheckoutFoldersScript", "configValue": "\"mainfolder/main\"" } ], "sourceNumber": 1 }, { "instanceId": 42863, "configValues": [ { "configName": "SparseCheckoutFoldersScript", "configValue": "\"EBS\"" } ], "sourceNumber": 2 } ] }, "containerConfiguration": {, "dockerfile": "new docker file name" "dockerStreams": [ { "isImageBuild": false, "isImagePush": null, "streamName": "master", "imageName": "new image name" } ], "kubernetesConfiguration": { "manifestsToDeploy": [ "deploymanifest1" ], "blueGreenManifests": [ "bluegreenmanifest1" ], "canaryManifests": [ "canarymanifest1" ], "abmanifests": [ "abmanifest1", "abmanifest2" ], "helmConfiguration": { "parametersMap": [ { "key": "key1", "valueScript": "new value" } ], "releaseName": "new release name", "chart": "new chart name" }, "deploymentName": "new deployment name" } }
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.
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. |
packageBuildType | 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 | String | Description of the project. |
priority | Integer | Deploy priority of the project. Null input defaults to 1. |
webhooksEnabled | Boolean | Whether or not webhooks are enabled. Null input defaults to false. |
projectBuildSequence | Integer | Update the value for the ProjectBuildSequence variable which can be used in stream syntax scripts. |
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, 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. |
preDeployInfo | ProjectPreDeployInfo | PreDeploy info for the project. See more info about the ProjectPreDeployInfo 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. |
contianerConfiguration | ContainerConfiguration | Container configuration for the project. See more info about the ContainerConfiguration type below. |
ProjectBuildInfo
Attribute | Type | Description |
---|---|---|
workflowId | Long | Id of the build workflow used by this project. |
instanceId | 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 | Type | Description |
---|---|---|
workflowId | Long | Id of the deployment workflow used by this project. |
instanceIds | List<Long> | Id of each of the instances where the project can be deployed. New instance ids will be added to the existing list of instance ids for deployment. |
UtilityProjectExecutionInfo
Attribute | Type | Description |
---|---|---|
workflowId | Long | Id of the utility workflow used by this project. |
instanceIds | List<Long> | Id of each of the utility instance where this project can be run. New instance ids will be added to the existing list of instance ids. |
ProjectSCMPojo
Attribute | Type | Description |
---|---|---|
sources | List<ProjectSCMConfig> | List of SCM configuration sources. See more info about the ProjectSCMConfig object below. |
ProjectSCMConfig
Attribute | Type | Description |
---|---|---|
instanceId | Long | SCM instance id for this source. |
configValues | List<ProjectSCMConfigValue> | Configuration values for each SCM source. See more info about the ProjectSCMConfigValue object below. |
sourceNumber | Integer | Number for the source. Source numbers start at 1 and increment for each source after that. |
ProjectSCMConfigValue
Attribute | Type | Description |
---|---|---|
configName | String | Name of the configuration attribute. |
configValue | String | Value of the configuration attribute. |
ContainerConfiguration
Attribute | Type | Description |
---|---|---|
dockerFile | String | Name of the dockerfile |
dockerStreams | List<DockerStream> | Information about the docker streams. See more info about the DockerStream type below. |
kubernetesConfiguration | KubernetesConfiguration | Configuration for Kubernetes. See more info about the KubernetesConfiguration type below. |
DockerStream
Attribute | Type | Description |
---|---|---|
streamId | Long | Id of the stream. |
streamName | String | Name of the stream. |
imageName | String | Name of the image. |
isImageBuild | Boolean | If the image will build. |
isImagePush | Boolean | If the image will push. Null if isImageBuild is false. |
KubernetesConfiguration
Attribute | Type | Description |
---|---|---|
deploymentName | String | Name of the deployment. |
manifestsToDeploy | List<String> | Manifests to deploy. |
blueGreenManifests | List<String> | Blue green manifests. |
canaryManifests | List<String> | Canary manifests. |
abmanifests | List<String> | AB manifests. |
helmConfiguration | HelmConfiguration | The helm configuration. See more info about the HelmConfiguration type below. |
HelmConfiguration
Attribute | Type | Description |
---|---|---|
chart | String | Name of the chart. |
releaseName | String | Name of the release. |
parametersMap | List<ParameterMap> | All of the parameter mappings. See more info about the ParmaterMap type below. |
ParameterMap
Attribute | Type | Description |
---|---|---|
key | String | Key for the parameter map. |
value | String | Value for the parameter map. |
SCM Configuration Names by Type
All values not provided are defaulted. All defaults are configured from the Administration > Defaults page.
Response
Attribute | Type | Description |
---|---|---|
projectId | Long | Id of the project. |
projectName | String | Unique name of the project. |
applicationId | String | 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. |
packageBuildType | 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 | String | Description of the project. |
projectClassification | String | The classification of the project, such as "Standard" or "PartialDeployments" |
priority | Integer | Deploy priority of the project. |
webhooksEnabled | Boolean | Whether or not webhooks are enabled. |
projectBuildSequence | Integer | The current value for the next ProjectBuildSequence number. |
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, PVCS, FILE, or NONE. |
priorityScope | String | This specifies the priority scope of the current project. Either Global, Folder, or Application. |
buildInfo | ProjectBuildInfo | Build info for the project. See more info about the ProjectBuildInfo object below. |
preDeployInfo | ProjectPreDeployInfo | PreDeploy info for the project. See more info about the ProjectPreDeployInfo object below. |
deployInfo | ProjectDeployInfo |