REST V1 Project Response

Response

AttributeTypeDescription

projectId

Long

Id of the project.

projectName

String

Unique name of the project.

folderId

String

Id of the folder the project is in.

projectPath

String

Fully qualified project path.

isActive

Boolean

Boolean that tracks whether or not the project is active. Null input defaults to true.

packageBuildTypeStringString 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.

webhooksEnabledBooleanWhether or not webhooks are enabled.
projectBuildSequenceIntegerThe 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.

preDeployInfoProjectPreDeployInfoPreDeploy 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.

containerConfigurationContainerConfiguration

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

linksList<Link>List of any relevant links for the object.

ProjectBuildInfo

AttributeTypeDescription
workflowIdLongId of the build workflow used by this project.
instanceIdLongId of the instance where this project is built.

ProjectPreDeployInfo

AttributeTypeDescription
workflowIdLong

Id of the predeployment workflow used by this project.

Note - If predeploy workflow is used, then ProjectDeployInfo.instanceIds is needed

ProjectDeployInfo

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

UtilityProjectExecutionInfo

AttributeTypeDescription
workflowIdLongId of the utility workflow used by this project.
instanceIdsList<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.
isTagLatestBooleanIf the image will be tagged as latest
registryAccountStringThe Docker Registry Account Code to push to.
imageScanBooleanIf the image will be scanned with Anchore.
containerDockerStreamContainerContainer configuration during deployment

DockerStreamContainer

AttributeTypeDescription
runContainer
BooleanRun a container with this image during deployment
containerName
StringGroovy Script of the container name to run
volumesStringGroovy Script of the volumes to bind to the container
portsBooleanGroovy Script of the ports to bind to the container
additionalParamsBooleanGroovy Script for any additional arguments to pass the run container command

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.

Link

AttributeTypeDescription
typeStringType of the link "REST", "UI"
linkStringPhysical link of the object.

The following macros are not currently supported in the footer:
  • style