Project API
- Karl Henselin
- Chandresh Patel
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. |
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 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 | 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"
}
}
POST
Create Project
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 | Type | Description |
|---|---|---|---|
configName | Yes | String | Name of the configuration attribute. |
configValue | No | String | Value of the configuration attribute. |
ContainerConfiguration
Attribute | Required | Type | Description |
|---|---|---|---|
dockerFile | Yes | String | Name of the dockerfile |
dockerStreams | Yes | List<DockerStream> | Information about the docker streams. See more info about the DockerStream type below. |
kubernetesConfiguration | No | 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 | Required | Type | Description |
|---|---|---|---|
deploymentName | No | String | Name of the deployment. |
manifestsToDeploy | No | List<String> | Manifests to deploy. |
blueGreenManifests | No | List<String> | Blue green manifests. |
canaryManifests | No | List<String> | Canary manifests. |
abmanifests | No | List<String> | AB manifests. |
helmConfiguration | Yes | HelmConfiguration | The helm configuration. See more info about the HelmConfiguration type below. |
HelmsConfiguration
Attribute | Required | Type | Description |
|---|---|---|---|
chart | Yes | String | Name of the chart. |
releaseName | Yes | String | Name of the release. |
parametersMap | No | List<ParameterMap> | All of the parameter mappings. See more info about the ParmaterMap type below. |
ParameterMap
Attribute | Required | Type | Description |
|---|---|---|---|
key | Yes | String | Key for the parameter map. |
value | Yes | 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 a POST request is sent to http://host:port/flexdeploy/rest/v1/project receiving the following JSON project object,
POST JSON
{
"projectName": "Example Project",
"projectPath": "FlexDeploy/Testing/Example Project",
"description": "Project created with API",
"projectClassification": "Standard",
"priority": 2,
"projectType": "EBS",
"scmType": "GIT",
"mainStreamName": "master",
"webhooksEnabled": true,
"buildInfo": {
"instanceId": 15925,
"workflowId": 43164
},
"deployInfo": {
"instanceIds": [80524, 93048],
"workflowId": 34540
},
"preDeployInfo": {
"workflowId": 42978
},
"scmConfiguration": {
"sources": [
{
"instanceId": 16465,
"configValues": [
{
"configName": "SparseCheckoutFoldersScript",
"configValue": "\"mainfolder/main\""
}
],
"sourceNumber": 1
},
{
"instanceId": 46947,
"configValues": [
{
"configName": "SparseCheckoutFoldersScript",
"configValue": "\"EBS\""
}
],
"sourceNumber": 2
}
]
},
"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"
}
}
}
the following project object will then be created in FlexDeploy:
POST JSON
{
"projectName": "Example Project",
"projectId": 10002,
"projectPath": "FlexDeploy/Testing/Example Project",
"description": "Project created with API",
"isActive": true,
"projectClassification": "Standard",
"priority": 2,
"projectType": "EBS",
"priorityScope": "Application",
"applicationId": 14852,
"scmType": "GIT",
"mainStreamName": "master",
"webhooksEnabled": true,
"streams": [73419],
"buildInfo": {
"instanceId": 15925,
"workflowId": 43164
},
"deployInfo": {
"instanceIds": [80524, 93048],
"workflowId": 34540
},
"preDeployInfo": {
"workflowId": 42978
},
"utilityExecutionInfo": null,
"scmConfiguration": {
"sources": [
{
"instanceId": 16465,
"configValues": [
{
"configName": "SparseCheckoutFoldersScript",
"configValue": "\"mainfolder/main\""
}
],
"sourceNumber": 1
},
{
"instanceId": 46947,
"configValues": [
{
"configName": "SparseCheckoutFoldersScript",
"configValue": "\"EBS\""
}
],
"sourceNumber": 2
}
]
},
"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"
}
}
}
Build Project (Using Id)
This POST service will perform the same action found on the Build Request Form. It will initiate a request to build the project with the given Id. The service will return workflow request. Workflow request id from return data can be used with Workflow Request API to determine when the execution is complete.
This page includes examples for Full and Partial deploy project builds.
API URLs
http://host:port/flexdeploy/rest/v1/project/(Id)/build
Request
- If trying to build a Partial Deploy project with all of the files in the repository (equivalent to Build - All Files button in the UI), then simply remove the "projectFiles" list, and the REST API will detect that the project is meant for partial deploys automatically and perform the build with all of the files.
Parameter | Required | Type | Description |
|---|---|---|---|
| environmentId | Y/N | Long | This is the environment Id, not the environment name that you see on most screens. It is required if the build instance is associated to multiple environments. If only one environment is associated to the build instance, it is not required. |
| streamId | Y/N | Long | The Id of the Stream that you want to build. If only one stream is present, you don't need to specify the stream. |
| forceBuild | N | Boolean | Values are true or false. Indicates that the build should occur even if there are not SCM changes. Defaults to false. |
| relatedTickets | N | String | List of Issue Tracking System tickets. |
| workflowVersionOverride | N | String | Optionally the version of the workflow can be overridden. Defaults to the currently active version. |
| inputs | N | List<Input> | See Common Parameters below. |
| flexFields | N | List<FlexField> | See Common Parameters below. |
| packageName | Y/N | String | Required for partial deployment project builds. The name of the package to build. The package must already exist. |
| releaseId | N | String | Id of the release to which this build is related to. If specified, a new snapshot is going to be created. |
Input
This is a list of code/value pairs for the inputs. Not all inputs need to be supplied. If an input has a default value that is acceptable for the Workflow to run, it does not need to be supplied.
Attribute | Required | Type | Description |
|---|---|---|---|
| code | Y | String | The code of the Input |
| value | N | String | The value of the Input |
FlexField
This is a list of the code/value pairs for the FlexFields (not the Display Name). Not all FlexFields need to be supplied. If a FlexField has a default value or options that are acceptable for the workflow to run, it does not need to be changed.
Attribute | Required | Type | Description |
|---|---|---|---|
| code | Y | String | The code of the FlexField |
| value | N | String | The value of the FlexField |
Attributes | Type | Description |
|---|---|---|
| allFilesRequested | boolean | If it was a partial deploy project and the "(All Files)" Package was selected True otherwise False |
| createdBy | String | the name of the user that created the build request |
| createdOn | Date Time | The time the request was received |
| deploymentStrategy | String or null | |
| environmentId | long | The environment on which the build is being performed |
| finishDeployment | any | |
| flexField1 | any | |
| flexField2 | any | |
| flexField3 | any | |
| flexField4 | any | |
| flexField5 | any | |
| flexField6 | any | |
| flexField7 | any | |
| flexField8 | any | |
| flexField9 | any | |
| flexField10 | any | |
| folderId | long | the closest parent folder to the project |
| force | boolean | indicates if force deploy or force build was selected on the request |
| groupRequestId | long or null | |
| inputs | array | |
| instances | array | |
| isException | boolean | |
| newWeight | any | |
| oldWeight | any | |
| pipelineStageExecId | long or null | long if it was a release build, otherwise null |
| pipelineStageStepExecId | long or null | long if it was a release build, otherwise null |
| predeployRequestedStartTime | any | |
| predeployWorkflowExecId | long or null | long if there was a predeploy workflow that executed, otherwise null |
| priority | long | |
| projectId | long | The ID of the project |
| projectStreamId | long | The ID of the project Stream |
| projectVersionId | long | The ID of the Project Version |
| projectWorkflowId | long | The ID of the ProjectWorkflow |
| relDefinitionId | long or null | long if it was a release build, otherwise null |
| relSnapshotId | long or null | long if it was a release build, otherwise null |
| requestedStartTime | any | null unless a delayed start time was given |
| requestStatus | ENUM | READY, |
| routeRule | any | |
| stopOnPkgError | boolean | |
| triggerType | ENUM | MANUAL |
| updatedBy | string | |
| updatedOn | date time with zone | |
| versionNumber | long | |
| workflowId | long | The ID of the Workflow |
| workflowRequestId | long | The ID of the WorkflowRequest |
| workflowType | ENUM | BUILD, DEPLOY, PREDEPLOY, TEST, OTHER, TEST_DEFINITION, UTILITY |
| workflowVersionOverride | any | null unless a workflow version override was specified for this request. |
Response Codes
HTTP Code | Description |
|---|---|
| 200 | No changes were detected, no build initiated. |
| 201 | Project build was initiated successfully |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 404 | Project not found |
| 500 | Unexpected internal server error |
Example
We can build a Project with Id 10004 with this request:
API URLs
http://host:port/flexdeploy/rest/v1/project/10004/build
Sample JSON Request
{
"environmentId": 11595,
"forceBuild": false,
"streamId": 3502
}
In response, we will receive a data object with information about the request.
{
"createdBy": "fdadmin",
"updatedOn": "2022-04-26T20:23:08.579+0000",
"createdOn": "2022-04-26T20:23:08.501+0000",
"updatedBy": "fdadmin",
"versionNumber": 2,
"projectWorkflowId": 4103,
"relDefinitionId": null,
"folderVersionId": null,
"workflowVersionOverride": null,
"requestStatus": "READY",
"requestedStartTime": null,
"isException": false,
"flexField1": null,
"flexField2": null,
"flexField3": null,
"flexField4": null,
"flexField5": null,
"flexField6": null,
"flexField7": null,
"flexField8": null,
"flexField9": null,
"flexField10": null,
"groupRequestId": null,
"stopOnPkgError": false,
"pipelineStageStepExecId": null,
"relSnapshotId": null,
"pipelineStageExecId": null,
"deploymentStrategy": null,
"newWeight": null,
"oldWeight": null,
"routeRule": null,
"finishDeployment": null,
"predeployWorkflowExecId": null,
"predeployRequestedStartTime": null,
"instances": null,
"folderId": 4743642,
"workflowRequestId": 275337,
"projectId": 3501,
"environmentId": 11595,
"workflowId": 4122,
"inputs": null,
"projectStreamId": 3502,
"force": false,
"projectVersionId": 16786148,
"workflowType": "BUILD",
"triggerType": "MANUAL",
"priority": 1
}
Deploy Project (Using Id)
This POST service will perform the same action found on the Deployment Request Form off the project screen. It will initiate a request to deploy the project specified with the project Id. The service will return workflow request. Workflow request id from return data can be used with Workflow Request API to determine when the execution is complete.
API URL
http://host:port/flexdeploy/rest/v1/project/{Id}/deploy
Request
| Parameter | Required | Type | Description |
|---|---|---|---|
| environmentId | Y | Long | This is the environment id, not the environment name that is seen on most screens. |
| instanceIds | N | Array of Long | The list of instances where the deployment will occur. Make sure to enter the instance id, not the instance name that is seen on most screens. If not provided, all deploy instances configured for Project will be used for deployment. |
| projectId | Y | Long | The Id of the project to deploy. |
| packageDetails | N* | Array of PackageInfo | This is required for partial deployments, but not for full deployments. Included to indicate what should be deployed in a partial deployment. See more info on PackageInfo below. |
| forceDeploy | N | Boolean | Values are true or false. Indicates that the deployment should occur even when the projectVersionId is already deployed to that instance. Defaults to false. |
| exceptionToWindow | N | Boolean | Values are true or false. Indicates that the deployment is an exception to the deployment window. Defaults to false. |
| projectVersionId | N | Long | The id of the project version to be deployed. If not specified, the most recently built projectVersionId will be deployed. |
| startTime | N | String | The time when the deployment will be started. Format should yyyy-MM-dd'T'HH:mm:ssXXX. For example, 2019-03-16T21:17:52-06:00 |
| workflowVersionOverride | N | String | Optionally, the version of the workflow can be overridden. |
| inputs | N | Array | See Common Parameters below. |
| flexFields | N | Array | See Common Parameters below. |
| changeTickets | N | Array of String | Ticket number for the given deployment, using the configured Change Management System. |
Input
This is a list of code/value pairs for the workflow inputs. Not all inputs need to be supplied. If an input has a default value that is acceptable for the workflow to run, it does not need to be supplied.
| Attribute | Required | Type | Description |
|---|---|---|---|
| code | Y | String | The code of the input |
| value | N | String | The value of the input |
FlexField
This is the list of the code/value pairs for the FlexFields (not the display name). Not all FlexFields need to be supplied. If a FlexFields has a default value or options that are acceptable for the workflow to run, it does not need to be changed.
| Attribute | Required | Type | Description |
|---|---|---|---|
| code | Y | String | The code of the FlexField |
| value | N | String | The value of the FlexField |
PackageInfo
| Attribute | Required | Type | Description |
|---|---|---|---|
| packageName | N | String | The name of the package to deploy. If blank, all files will be assumed. |
| priority | N | Integer | The priority of the package. If it is not indicated, then FlexDeploy will deploy the packages in the order they are provided in the JSON request. |
| projectVersionId | Y* | Long | The id of the project version to deploy. This parameter is not required if useLatestPackageVersion is true. |
| useLatestPackageVersion | N | Boolean | Uses the most recent package version. Defaults to false. |
Response
| Attribute | Type | Description |
|---|---|---|
| warningMessage | String | Indicates any warning message in the event where the request was successful but no new deployment was initiated. For example: Project Version is already deployed and force deploy wasn't specified |
| warningCode | String | Matching warning code for the warning message. |
| workflowRequests | Array | Array of workflow request objects |
Response Codes
| HTTP Code | Description |
|---|---|
| 200 | Project version already deployed |
| 201 | Deploy request initiated successfully |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 404 | Project not found |
| 500 | Unexpected internal server error |
Example Deploy Request
We can deploy a project with Id 10004 with the following request:
API URLs
http://host:port/flexdeploy/rest/v1/project/10004/deploy
{
"instanceIds":[100001],
"environmentId":12345,
"forceDeploy":"false",
"inputs":
[
{
"code":"RESTART_SEVER",
"value":"true"
},
{
"code":"COMMENT",
"value":"Deploying from REST API"
}
]
}
In response, we will receive an array of workflowRequests:
{
"warningMessage": null,
"warningCode": null,
"workflowRequests": [
{
"packageName": null,
"folderName": "Human Resources",
"releaseSnapshotId": null,
"workflowRequestStatus": "READY",
"folderId": 10001,
"exceptionToWindow": false,
"releaseDefinitionId": null,
"cmsissues": "",
"workflowRequestId": 12001,
"projectName": "ProcessHRRequest",
"projectStreamId": 10502,
"projectVersionName": "1.0.8",
"requestAllFiles": false,
"projectVersionId": 29201,
"environmentId": 11210,
"folderRequestId": null,
"flexFields": [],
"folderPath": "FlexDeploy/Human Resources",
"projectId": 10501,
"requestedBy": "fdadmin",
"requestedStartTime": null,
"force": true,
"stopOnPackageError": null,
"workflowOverrideVersion": null,
"folderVersionId": null
}
]
}
Execute Utility Project (Using Id)
This POST service will perform the same action found on the Execute Utility Project Request Form off the project screen. It will initiate a request to execute the project with the Project ID specified in the URL. The service will return workflow request. Workflow request id from return data can be used with Workflow Request API to determine when the execution is complete.
API URLs
http://host:port/flexdeploy/rest/v1/project/{id}/execute
Request
Attributes | Required | Type | Description |
|---|---|---|---|
| id | Y | URL | This is a URL path parameter for the id which is used to execute a project. |
environmentId | Y | Long | The Id of the Environment the project should be executed in. |
instanceIds | N | List<Long> | A list of Instance Ids that the project should be executed on. If not supplied, the project will execute on the instances that are associated to the utility project. |
exceptionToWindow | N | Boolean | Values are true or false. Indicates that the deployment is an exception to the deployment window. Defaults to false. |
startTime | N | DateTime | The time when the deployment will be started. The expected time format is: |
workflowVersionOverride | N | String | Optionally, specify a workflow version to override the active workflow version. |
inputs | N | Array | This is a list of |
flexFields | N | Array | This is a list of the |
Response
Attributes | Type | Description |
|---|---|---|
| warningMessage | String | Indicates any warning message in the event where the request was successful but no execution was initiated. |
| warningCode | String | Matching warning code for the warning message. |
workflowRequests | Array | Array of workflow request objects |
Response Codes
| HTTP Code | Description |
|---|---|
| 201 | Project was found and executed |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 500 | Unexpected internal server error |
Example
We can execute a Utility Project with Id 10004 with this request:
URL: http://host:port/flexdeploy/rest/v1/project/10004/execute
{
"environmentId":10045,
"instanceIds":[10044],
"exceptionToWindow":false,
"startTime":"2018-07-20T11:31:06Z",
"workflowVersionOverride":"1.0",
"inputs":[
{"code":"INPUT1","value":"Test"},
{"code":"INPUT2","value":"1234"}
],
"flexFields":[
{"code":"FLEXFIELD1","value":"123"},
{"code":"FLEXFIELD2","value":"abc"}
]
}
In response, we will receive an array of workflowRequests:
{
"warningCode": null,
"warningMessage": null,
"wfrequests": [
{
"packageName": null,
"workflowOverrideVersion": null,
"stopOnPackageError": null,
"workflowRequestStatus": "READY",
"exceptionToWindow": false,
"projectName": "Util",
"workflowRequestId": 11819,
"requestAllFiles": false,
"projectStreamId": 29802,
"projectVersionName": "1.0.1",
"projectVersionId": 29809,
"environmentId": 11210,
"folderRequestId": null,
"folderPath": "FlexDeploy/HR Utils",
"flexFields": [],
"projectId": 29801,
"folderId": 10001,
"requestedStartTime": null,
"folderVersionId": null,
"folderName": "HR Utils",
"requestedBy": "fdadmin",
"releaseDefinitionId": null,
"cmsissues": "",
"force": true,
"releaseSnapshotId": null
}
]
}
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. |
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 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 | 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"
}
}
POST
Create Project
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 | Type | Description |
|---|---|---|---|
configName | Yes | String | Name of the configuration attribute. |
configValue | No | String | Value of the configuration attribute. |
ContainerConfiguration
Attribute | Required | Type | Description |
|---|---|---|---|
dockerFile | Yes | String | Name of the dockerfile |
dockerStreams | Yes | List<DockerStream> | Information about the docker streams. See more info about the DockerStream type below. |
kubernetesConfiguration | No | 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 | Required | Type | Description |
|---|---|---|---|
deploymentName | No | String | Name of the deployment. |
manifestsToDeploy | No | List<String> | Manifests to deploy. |
blueGreenManifests | No | List<String> | Blue green manifests. |
canaryManifests | No | List<String> | Canary manifests. |
abmanifests | No | List<String> | AB manifests. |
helmConfiguration | Yes | HelmConfiguration | The helm configuration. See more info about the HelmConfiguration type below. |
HelmsConfiguration
Attribute | Required | Type | Description |
|---|---|---|---|
chart | Yes | String | Name of the chart. |
releaseName | Yes | String | Name of the release. |
parametersMap | No | List<ParameterMap> | All of the parameter mappings. See more info about the ParmaterMap type below. |
ParameterMap
Attribute | Required | Type | Description |
|---|---|---|---|
key | Yes | String | Key for the parameter map. |
value | Yes | 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 a POST request is sent to http://host:port/flexdeploy/rest/v1/project receiving the following JSON project object,
POST JSON
{
"projectName": "Example Project",
"projectPath": "FlexDeploy/Testing/Example Project",
"description": "Project created with API",
"projectClassification": "Standard",
"priority": 2,
"projectType": "EBS",
"scmType": "GIT",
"mainStreamName": "master",
"webhooksEnabled": true,
"buildInfo": {
"instanceId": 15925,
"workflowId": 43164
},
"deployInfo": {
"instanceIds": [80524, 93048],
"workflowId": 34540
},
"preDeployInfo": {
"workflowId": 42978
},
"scmConfiguration": {
"sources": [
{
"instanceId": 16465,
"configValues": [
{
"configName": "SparseCheckoutFoldersScript",
"configValue": "\"mainfolder/main\""
}
],
"sourceNumber": 1
},
{
"instanceId": 46947,
"configValues": [
{
"configName": "SparseCheckoutFoldersScript",
"configValue": "\"EBS\""
}
],
"sourceNumber": 2
}
]
},
"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"
}
}
}
the following project object will then be created in FlexDeploy:
POST JSON
{
"projectName": "Example Project",
"projectId": 10002,
"projectPath": "FlexDeploy/Testing/Example Project",
"description": "Project created with API",
"isActive": true,
"projectClassification": "Standard",
"priority": 2,
"projectType": "EBS",
"priorityScope": "Application",
"applicationId": 14852,
"scmType": "GIT",
"mainStreamName": "master",
"webhooksEnabled": true,
"streams": [73419],
"buildInfo": {
"instanceId": 15925,
"workflowId": 43164
},
"deployInfo": {
"instanceIds": [80524, 93048],
"workflowId": 34540
},
"preDeployInfo": {
"workflowId": 42978
},
"utilityExecutionInfo": null,
"scmConfiguration": {
"sources": [
{
"instanceId": 16465,
"configValues": [
{
"configName": "SparseCheckoutFoldersScript",
"configValue": "\"mainfolder/main\""
}
],
"sourceNumber": 1
},
{
"instanceId": 46947,
"configValues": [
{
"configName": "SparseCheckoutFoldersScript",
"configValue": "\"EBS\""
}
],
"sourceNumber": 2
}
]
},
"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"
}
}
}
Build Project (Using Id)
This POST service will perform the same action found on the Build Request Form. It will initiate a request to build the project with the given Id. The service will return workflow request. Workflow request id from return data can be used with Workflow Request API to determine when the execution is complete.
This page includes examples for Full and Partial deploy project builds.
API URLs
http://host:port/flexdeploy/rest/v1/project/(Id)/build
Request
- If trying to build a Partial Deploy project with all of the files in the repository (equivalent to Build - All Files button in the UI), then simply remove the "projectFiles" list, and the REST API will detect that the project is meant for partial deploys automatically and perform the build with all of the files.
Parameter | Required | Type | Description |
|---|---|---|---|
| environmentId | Y/N | Long | This is the environment Id, not the environment name that you see on most screens. It is required if the build instance is associated to multiple environments. If only one environment is associated to the build instance, it is not required. |
| streamId | Y/N | Long | The Id of the Stream that you want to build. If only one stream is present, you don't need to specify the stream. |
| forceBuild | N | Boolean | Values are true or false. Indicates that the build should occur even if there are not SCM changes. Defaults to false. |
| relatedTickets | N | String | List of Issue Tracking System tickets. |
| workflowVersionOverride | N | String | Optionally the version of the workflow can be overridden. Defaults to the currently active version. |
| inputs | N | List<Input> | See Common Parameters below. |
| flexFields | N | List<FlexField> | See Common Parameters below. |
| packageName | Y/N | String | Required for partial deployment project builds. The name of the package to build. The package must already exist. |
| releaseId | N | String | Id of the release to which this build is related to. If specified, a new snapshot is going to be created. |
Input
This is a list of code/value pairs for the inputs. Not all inputs need to be supplied. If an input has a default value that is acceptable for the Workflow to run, it does not need to be supplied.
Attribute | Required | Type | Description |
|---|---|---|---|
| code | Y | String | The code of the Input |
| value | N | String | The value of the Input |
FlexField
This is a list of the code/value pairs for the FlexFields (not the Display Name). Not all FlexFields need to be supplied. If a FlexField has a default value or options that are acceptable for the workflow to run, it does not need to be changed.
Attribute | Required | Type | Description |
|---|---|---|---|
| code | Y | String | The code of the FlexField |
| value | N | String | The value of the FlexField |
Attributes | Type | Description |
|---|---|---|
| allFilesRequested | boolean | If it was a partial deploy project and the "(All Files)" Package was selected True otherwise False |
| createdBy | String | the name of the user that created the build request |
| createdOn | Date Time | The time the request was received |
| deploymentStrategy | String or null | |
| environmentId | long | The environment on which the build is being performed |
| finishDeployment | any | |
| flexField1 | any | |
| flexField2 | any | |
| flexField3 | any | |
| flexField4 | any | |
| flexField5 | any | |
| flexField6 | any | |
| flexField7 | any | |
| flexField8 | any | |
| flexField9 | any | |
| flexField10 | any | |
| folderId | long | the closest parent folder to the project |
| force | boolean | indicates if force deploy or force build was selected on the request |
| groupRequestId | long or null | |
| inputs | array | |
| instances | array | |
| isException | boolean | |
| newWeight | any | |
| oldWeight | any | |
| pipelineStageExecId | long or null | long if it was a release build, otherwise null |
| pipelineStageStepExecId | long or null | long if it was a release build, otherwise null |
| predeployRequestedStartTime | any | |
| predeployWorkflowExecId | long or null | long if there was a predeploy workflow that executed, otherwise null |
| priority | long | |
| projectId | long | The ID of the project |
| projectStreamId | long | The ID of the project Stream |
| projectVersionId | long | The ID of the Project Version |
| projectWorkflowId | long | The ID of the ProjectWorkflow |
| relDefinitionId | long or null | long if it was a release build, otherwise null |
| relSnapshotId | long or null | long if it was a release build, otherwise null |
| requestedStartTime | any | null unless a delayed start time was given |
| requestStatus | ENUM | READY, |
| routeRule | any | |
| stopOnPkgError | boolean | |
| triggerType | ENUM | MANUAL |
| updatedBy | string | |
| updatedOn | date time with zone | |
| versionNumber | long | |
| workflowId | long | The ID of the Workflow |
| workflowRequestId | long | The ID of the WorkflowRequest |
| workflowType | ENUM | BUILD, DEPLOY, PREDEPLOY, TEST, OTHER, TEST_DEFINITION, UTILITY |
| workflowVersionOverride | any | null unless a workflow version override was specified for this request. |
Response Codes
HTTP Code | Description |
|---|---|
| 200 | No changes were detected, no build initiated. |
| 201 | Project build was initiated successfully |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 404 | Project not found |
| 500 | Unexpected internal server error |
Example
We can build a Project with Id 10004 with this request:
API URLs
http://host:port/flexdeploy/rest/v1/project/10004/build
Sample JSON Request
{
"environmentId": 11595,
"forceBuild": false,
"streamId": 3502
}
In response, we will receive a data object with information about the request.
{
"createdBy": "fdadmin",
"updatedOn": "2022-04-26T20:23:08.579+0000",
"createdOn": "2022-04-26T20:23:08.501+0000",
"updatedBy": "fdadmin",
"versionNumber": 2,
"projectWorkflowId": 4103,
"relDefinitionId": null,
"folderVersionId": null,
"workflowVersionOverride": null,
"requestStatus": "READY",
"requestedStartTime": null,
"isException": false,
"flexField1": null,
"flexField2": null,
"flexField3": null,
"flexField4": null,
"flexField5": null,
"flexField6": null,
"flexField7": null,
"flexField8": null,
"flexField9": null,
"flexField10": null,
"groupRequestId": null,
"stopOnPkgError": false,
"pipelineStageStepExecId": null,
"relSnapshotId": null,
"pipelineStageExecId": null,
"deploymentStrategy": null,
"newWeight": null,
"oldWeight": null,
"routeRule": null,
"finishDeployment": null,
"predeployWorkflowExecId": null,
"predeployRequestedStartTime": null,
"instances": null,
"folderId": 4743642,
"workflowRequestId": 275337,
"projectId": 3501,
"environmentId": 11595,
"workflowId": 4122,
"inputs": null,
"projectStreamId": 3502,
"force": false,
"projectVersionId": 16786148,
"workflowType": "BUILD",
"triggerType": "MANUAL",
"priority": 1
}
Deploy Project (Using Id)
This POST service will perform the same action found on the Deployment Request Form off the project screen. It will initiate a request to deploy the project specified with the project Id. The service will return workflow request. Workflow request id from return data can be used with Workflow Request API to determine when the execution is complete.
API URL
http://host:port/flexdeploy/rest/v1/project/{Id}/deploy
Request
| Parameter | Required | Type | Description |
|---|---|---|---|
| environmentId | Y | Long | This is the environment id, not the environment name that is seen on most screens. |
| instanceIds | N | Array of Long | The list of instances where the deployment will occur. Make sure to enter the instance id, not the instance name that is seen on most screens. If not provided, all deploy instances configured for Project will be used for deployment. |
| projectId | Y | Long | The Id of the project to deploy. |
| packageDetails | N* | Array of PackageInfo | This is required for partial deployments, but not for full deployments. Included to indicate what should be deployed in a partial deployment. See more info on PackageInfo below. |
| forceDeploy | N | Boolean | Values are true or false. Indicates that the deployment should occur even when the projectVersionId is already deployed to that instance. Defaults to false. |
| exceptionToWindow | N | Boolean | Values are true or false. Indicates that the deployment is an exception to the deployment window. Defaults to false. |
| projectVersionId | N | Long | The id of the project version to be deployed. If not specified, the most recently built projectVersionId will be deployed. |
| startTime | N | String | The time when the deployment will be started. Format should yyyy-MM-dd'T'HH:mm:ssXXX. For example, 2019-03-16T21:17:52-06:00 |
| workflowVersionOverride | N | String | Optionally, the version of the workflow can be overridden. |
| inputs | N | Array | See Common Parameters below. |
| flexFields | N | Array | See Common Parameters below. |
| changeTickets | N | Array of String | Ticket number for the given deployment, using the configured Change Management System. |
Input
This is a list of code/value pairs for the workflow inputs. Not all inputs need to be supplied. If an input has a default value that is acceptable for the workflow to run, it does not need to be supplied.
| Attribute | Required | Type | Description |
|---|---|---|---|
| code | Y | String | The code of the input |
| value | N | String | The value of the input |
FlexField
This is the list of the code/value pairs for the FlexFields (not the display name). Not all FlexFields need to be supplied. If a FlexFields has a default value or options that are acceptable for the workflow to run, it does not need to be changed.
| Attribute | Required | Type | Description |
|---|---|---|---|
| code | Y | String | The code of the FlexField |
| value | N | String | The value of the FlexField |
PackageInfo
| Attribute | Required | Type | Description |
|---|---|---|---|
| packageName | N | String | The name of the package to deploy. If blank, all files will be assumed. |
| priority | N | Integer | The priority of the package. If it is not indicated, then FlexDeploy will deploy the packages in the order they are provided in the JSON request. |
| projectVersionId | Y* | Long | The id of the project version to deploy. This parameter is not required if useLatestPackageVersion is true. |
| useLatestPackageVersion | N | Boolean | Uses the most recent package version. Defaults to false. |
Response
| Attribute | Type | Description |
|---|---|---|
| warningMessage | String | Indicates any warning message in the event where the request was successful but no new deployment was initiated. For example: Project Version is already deployed and force deploy wasn't specified |
| warningCode | String | Matching warning code for the warning message. |
| workflowRequests | Array | Array of workflow request objects |
Response Codes
| HTTP Code | Description |
|---|---|
| 200 | Project version already deployed |
| 201 | Deploy request initiated successfully |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 404 | Project not found |
| 500 | Unexpected internal server error |
Example Deploy Request
We can deploy a project with Id 10004 with the following request:
API URLs
http://host:port/flexdeploy/rest/v1/project/10004/deploy
{
"instanceIds":[100001],
"environmentId":12345,
"forceDeploy":"false",
"inputs":
[
{
"code":"RESTART_SEVER",
"value":"true"
},
{
"code":"COMMENT",
"value":"Deploying from REST API"
}
]
}
In response, we will receive an array of workflowRequests:
{
"warningMessage": null,
"warningCode": null,
"workflowRequests": [
{
"packageName": null,
"folderName": "Human Resources",
"releaseSnapshotId": null,
"workflowRequestStatus": "READY",
"folderId": 10001,
"exceptionToWindow": false,
"releaseDefinitionId": null,
"cmsissues": "",
"workflowRequestId": 12001,
"projectName": "ProcessHRRequest",
"projectStreamId": 10502,
"projectVersionName": "1.0.8",
"requestAllFiles": false,
"projectVersionId": 29201,
"environmentId": 11210,
"folderRequestId": null,
"flexFields": [],
"folderPath": "FlexDeploy/Human Resources",
"projectId": 10501,
"requestedBy": "fdadmin",
"requestedStartTime": null,
"force": true,
"stopOnPackageError": null,
"workflowOverrideVersion": null,
"folderVersionId": null
}
]
}
Execute Utility Project (Using Id)
This POST service will perform the same action found on the Execute Utility Project Request Form off the project screen. It will initiate a request to execute the project with the Project ID specified in the URL. The service will return workflow request. Workflow request id from return data can be used with Workflow Request API to determine when the execution is complete.
API URLs
http://host:port/flexdeploy/rest/v1/project/{id}/execute
Request
Attributes | Required | Type | Description |
|---|---|---|---|
| id | Y | URL | This is a URL path parameter for the id which is used to execute a project. |
environmentId | Y | Long | The Id of the Environment the project should be executed in. |
instanceIds | N | List<Long> | A list of Instance Ids that the project should be executed on. If not supplied, the project will execute on the instances that are associated to the utility project. |
exceptionToWindow | N | Boolean | Values are true or false. Indicates that the deployment is an exception to the deployment window. Defaults to false. |
startTime | N | DateTime | The time when the deployment will be started. The expected time format is: |
workflowVersionOverride | N | String | Optionally, specify a workflow version to override the active workflow version. |
inputs | N | Array | This is a list of |
flexFields | N | Array | This is a list of the |
Response
Attributes | Type | Description |
|---|---|---|
| warningMessage | String | Indicates any warning message in the event where the request was successful but no execution was initiated. |
| warningCode | String | Matching warning code for the warning message. |
workflowRequests | Array | Array of workflow request objects |
Response Codes
| HTTP Code | Description |
|---|---|
| 201 | Project was found and executed |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 500 | Unexpected internal server error |
Example
We can execute a Utility Project with Id 10004 with this request:
URL: http://host:port/flexdeploy/rest/v1/project/10004/execute
{
"environmentId":10045,
"instanceIds":[10044],
"exceptionToWindow":false,
"startTime":"2018-07-20T11:31:06Z",
"workflowVersionOverride":"1.0",
"inputs":[
{"code":"INPUT1","value":"Test"},
{"code":"INPUT2","value":"1234"}
],
"flexFields":[
{"code":"FLEXFIELD1","value":"123"},
{"code":"FLEXFIELD2","value":"abc"}
]
}
In response, we will receive an array of workflowRequests:
{
"warningCode": null,
"warningMessage": null,
"wfrequests": [
{
"packageName": null,
"workflowOverrideVersion": null,
"stopOnPackageError": null,
"workflowRequestStatus": "READY",
"exceptionToWindow": false,
"projectName": "Util",
"workflowRequestId": 11819,
"requestAllFiles": false,
"projectStreamId": 29802,
"projectVersionName": "1.0.1",
"projectVersionId": 29809,
"environmentId": 11210,
"folderRequestId": null,
"folderPath": "FlexDeploy/HR Utils",
"flexFields": [],
"projectId": 29801,
"folderId": 10001,
"requestedStartTime": null,
"folderVersionId": null,
"folderName": "HR Utils",
"requestedBy": "fdadmin",
"releaseDefinitionId": null,
"cmsissues": "",
"force": true,
"releaseSnapshotId": null
}
]
}
- style