REST V1 Project Response

REST V1 Project Response

Response

Attribute

Type

Description

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

@since 5.4.0.2 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

@since 5.5.0.0 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

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

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

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

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

Attribute

Type

Description

sources

List<ProjectSCMConfig>

List of SCM configuration sources. See more info about the ProjectSCMConfig object below.

ProjectSCMConfig

Attribute

Type

Description

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

Attribute

Type

Description

configName

String

Name of the configuration attribute.

configValue

String

Value of the configuration attribute.

ContainerConfiguration

Attribute

Type

Description

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

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

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

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

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

Attribute

Type

Description

key

String

Key for the parameter map.

value

String

Value 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