Project API GET By 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
idYesURLThis is a URL path parameter for the id which is used to find a project.

Response

AttributeTypeDescription

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.

description

String

Description of the project.

partialDeployment

Boolean

Whether the project allows partial deployments. Null input defaults to false.

priority

Integer

Deploy priority of the project.

webhooksEnabledBooleanWhether or not webhooks are enabled.

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.

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.

containerConfigurationContainerConfiguration

Container configuration for the project. See more info about the ContainerConfiguration type below.

ProjectBuildInfo

AttributeTypeDescription
buildWorkflowIdLongId of the build workflow used by this project.
buildInstanceIdLongId of the instance where this project is built.

ProjectDeployInfo

AttributeTypeDescription
deployWorkflowIdLongId of the deployment workflow used by this project.
deployInstanceIdsList<Long>Id of each of the instances where the project can be deployed.

UtilityProjectExecutionInfo

AttributeTypeDescription
utilityWorkflowIdLongId of the utility workflow used by this project.
utilityInstanceIdsList<Long>Id of each of the utility instance where this project can be run.

ProjectSCMPojo

AttributeTypeDescription
sourcesList<ProjectSCMConfig>List of SCM configuration sources. See more info about the ProjectSCMConfig object below.

ProjectSCMConfig

AttributeTypeDescription
instanceIdLongSCM instance id for this source.
configValuesList<ProjectSCMConfigValue>Configuration values for each SCM source. See more info about the ProjectSCMConfigValue object below.
sourceNumberIntegerNumber for the source. Source numbers start at 1 and increment for each source after that.

ProjectSCMConfigValue

AttributeTypeDescription
configNameStringName of the configuration attribute.
configValueStringValue of the configuration attribute.

ContainerConfiguration

AttributeTypeDescription
dockerFileStringName of the dockerfile
dockerStreamsList<DockerStream>Information about the docker streams. See more info about the DockerStream type below.
kubernetesConfigurationKubernetesConfigurationConfiguration for Kubernetes. See more info about the KubernetesConfiguration type below.

DockerStream

AttributeTypeDescription
streamIdLongId of the stream.
streamNameStringName of the stream.
imageNameStringName of the image.
isImageBuildBooleanIf the image will build.
isImagePushBooleanIf the image will push. Null if isImageBuild is false.

KubernetesConfiguration

AttributeTypeDescription
deploymentNameStringName of the deployment.
manifestsToDeployList<String>Manifests to deploy.
blueGreenManifestsList<String>Blue green manifests.
canaryManifestsList<String>

Canary manifests.

abmanifestsList<String>AB manifests.
helmConfigurationHelmConfigurationThe helm configuration. See more info about the HelmConfiguration type below.

HelmConfiguration

AttributeTypeDescription
chartStringName of the chart.
releaseNameStringName of the release.
parametersMapList<ParameterMap>All of the parameter mappings. See more info about the ParmaterMap type below.

ParameterMap

AttributeTypeDescription
keyStringKey for the parameter map.
valueStringValue for the parameter map.

Response Codes

HTTP CodeDescription
200Projects were found and returned
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
500Unexpected 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:

Project - "Project1"
{
    "priority": 1,
    "projectName": "XXHR",
    "projectId": 10002,
    "description": "EBS Customizations",
    "applicationId": 10011,
    "projectPath": "FlexDeploy/EBSCustomizations/HR/XXHR",
    "priorityScope": "Application",
    "partialDeployment": true,
    "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
    },
    "utilityExecutionInfo": null,
    "projectType": "EBS",
	"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"
        }
	}
}
The following macros are not currently supported in the footer:
  • style