Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

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 the workflowRequestId which can be used by the getWorkflowRequestStatus (version 0) call to determine when the workflow 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

environmentIdY

Long

This is the environment Id, not the environment name that you see on most screens.

streamId

Y

Long

The Id of 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.

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

flexFieldsNList<FlexField>See Common Parameters below.
projectFilesNList<ProjectFile>

Only for partial deployment project builds.

An array of objects with 2 fields each: path and scmRevision.

packageNameNString

Only for partial deployment project builds.

Unique name to identify a build for partial deployments project. Defaults to the project version if no value is provided.

If packageName is provided without projectFiles, files configured in that package will be used.

If packageName is provided with projectFiles, then input is used for build and package definition is updated with this projectFiles list.

If packageName and projectFiles are not provided for partial deployment project, then All Files build will be performed.

releaseIdNStringId 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
RequiredType
Description
codeYStringThe code of the Input
valueNString

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
RequiredType
Description
codeYStringThe code of the FlexField
valueNString

The value of the FlexField

ProjectFile

Attribute
RequiredType
Description
pathYStringFully qualified file path that is required inside the projectFiles parameter.
scmRevisionNLong

Optionally include the revision number that you would like to use for the build.

If it is not indicated, then FlexDeploy will use the latest revision as the default.

Response

Attributes

Type

Description

warningMessageString

Indicates any warning message in the event where the request was successful but no build was initiated.  

For example: No changes found in source control

warningCodeStringMatching warning code for the warning message.  

workflowRequests

Array

Array of workflow request objects

Response Codes

HTTP Code
Description
200No changes were detected, no build initiated.
201Project was built successfully
400Bad request
401Unauthorized
404Project not found
500Unexpected 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": 11101 ,
    "forceBuild": true,
    "workflowVersionOverride": null,
    "streamId": 11210,
    "inputs": [
    {
        "code":"input1","value": "xyz"
    },
    {
        "code":"input2","value": "123"
    }],
    "projectFiles":[
    {
        "path": "/java/xxt/oracle/xxPersonMainCO.java"
    },
    {
       "path": "/java/xxt/oracle/apps/managePersonCO.java",
       "scmRevision": "1515"
    }],
    "packageName": "ALM150",
    "relatedTickets": null,
    "flexFields": [{
        "code": "Build FlexField" ,
        "value": 10
    }],
    "releaseId": 27003
}

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": 12019,
            "projectName": "ProcessHRRequest",
            "projectStreamId": 10502,
            "projectVersionName": "1.0.9",
            "requestAllFiles": false,
            "projectVersionId": 30001,
            "environmentId": 11016,
            "folderRequestId": null,
            "flexFields": [],
            "folderPath": "FlexDeploy/Human Resources",
            "projectId": 10501,
            "requestedBy": "fdadmin",
            "requestedStartTime": null,
            "force": false,
            "stopOnPackageError": null,
            "workflowOverrideVersion": null,
            "folderVersionId": null
        }
    ]
}
  • No labels