Skip to main content

Cancel an application component build.

PATCH 
/applications/:applicationId/components/:applicationComponentId/builds/:id/cancel

Cancel an application component build.

Request​

Path Parameters

    applicationId stringrequired
    applicationComponentId stringrequired
    id stringrequired

Header Parameters

    X-Codenow-Api-Key anyrequired

    CodeNOW API Key

Responses​

Detail of the build

Schema

    id stringrequired


    The unique identifier of the build.

    url string

    URL to the build's dashboard.

    applicationComponentId stringrequired


    The unique identifier of the application component.

    version string


    The version of the application component build.

    buildType BuildType (string)

    Possible values: [RELEASE, PREVIEW, PRERELEASE]

    The type of the build

    branch string


    The branch from which the application component build was created .

    commit

    object

    nullable


    Commit from which the build was created.

    id string


    The commit SHA.

    shortId stringnullable


    The short commit SHA.

    message stringnullable


    The commit message.

    author

    object

    nullable


    Author of the commit.

    name string


    The name of the person.

    email string


    The email of the person.

    date date-time


    The date of the commit.

    committer

    object

    nullable


    Committer of the commit.

    name string


    The name of the person.

    email string


    The email of the person.

    date date-time


    The date of the commit.

    status BuildState (string)required

    Possible values: [INITIALISING, WAITING, BUILDING, SUCCESSFUL, FAILED, CANCELLED, LOST, INCOMPLETE]

    The status of the build
    INITIALISING: The build is being initialised
    WAITING: The build is waiting to be started
    BUILDING: The build is in progress
    SUCCESSFUL: The build has been successful
    FAILED: The build has failed
    CANCELLED: The build has been cancelled
    INCOMPLETE: Build is missing required CI results
    LOST: The status cannot be determined

    codeQuality

    object

    nullable


    Code Quality information
    Not all pipelines will provide this information.

    url string


    URL to the code quality report.

    status CodeQuality.Status (string)

    Possible values: [NOT_ANALYZED, ERROR, SUCCESSFUL, UNKNOWN]


    Status of the code quality.

    requestedBy string


    The user who requested the build.

    createdAt date-timerequired

    The time when the builds was requested

    archived boolean


    Whether the build is archived or not.
    Archived builds do not provide additional information (logs, code quality, etc.)

    deployTo

    object[]

    nullable


    The list of deployment targets after successful build.

  • Array [

    • environmentId stringrequired

    Possible values: non-empty


    Target environment for the deployment

    configurationType ConfigurationType (string)required

    Possible values: [latest, preview, branch]

    Default value: latest


    Controls which configuration will be used when deploying PREVIEW builds .

  • ]

    • actions string[]


    The list of actions that can be performed on the build.

    • cancel
    • build can be cancelled
    • rerun
    • build can be rerun (after failure or cancellation)
    pipeline string


    The pipeline used to create the build.

    errorMessage stringnullable


    The error message if the build failed.

    applicationPackage stringnullable


    Version pattern to specify application package to be created after successful build.

    results

    object[]

    nullable


    CI results associated with the build
    .

  • Array [

    • version string


    The version of the payload.

    type string


    The type of the payload.

    payload

    object


    The payload (data associated with CI build).

    oneOf


    The Git Revision information.

    type stringrequired

    Possible values: non-empty

    Default value: git-revision


    The type of the payload: git-revision

    version stringrequired

    Possible values: non-empty

    Default value: v1


    The version of the payload: v1

    repositoryUrl stringrequired

    Possible values: non-empty


    The URL of the repository.

    branch stringrequired

    Possible values: non-empty


    The branch from which being built.

    commitSha stringrequired

    Possible values: non-empty


    The commit SHA which is being built.

    type

    string

    Possible values: [container, maven, git-tag, link, npm, nuget, git-revision, code-quality, helm]

    type stringrequired

    Possible values: non-empty

    Default value: container


    The type of the payload: container

    version stringrequired

    Possible values: non-empty

    Default value: v1


    The version of the payload: v1

    repositoryUrl stringrequired

    Possible values: non-empty


    The URL of the container repository.

    artifactPath stringrequired

    Possible values: non-empty


    The path to the container artifact.

    artifactVersion stringrequired

    Possible values: non-empty


    The version of the container artifact.

    version string

  • ]

    • ciProvider string


    CI Provider associated with the build
    codenow - uses CodeNow CI
    external - uses external CI

Loading...