Skip to main content

List library builds.

GET 
/libraries/:libraryId/builds

List library builds.

Request​

Path Parameters

    libraryId stringrequired

    Possible values: non-empty

Query Parameters

    page int32

    Default value: 0

    size int32

    Default value: 10

Header Parameters

    X-Codenow-Api-Key anyrequired

    CodeNOW API Key

Responses​

Page of builds

Schema

    content

    object[]

    required

  • Array [

    • id stringrequired

    The unique identifier of the build.

    url string

    URL to the build's dashboard.

    libraryId stringrequired

    The unique identifier of the library.

    version stringrequired

    The version of the library build.

    buildType BuildType (string)

    Possible values: [RELEASE, PREVIEW, PRERELEASE]

    The type of the build

    branch stringrequired

    The branch from which the library build was created.

    commit

    object

    nullable

    Commit from which the build was created.<

    id stringrequired
    shortId stringrequired
    message stringrequired

    author

    object

    required

    name stringrequired
    email stringrequired
    date date-timerequired

    committer

    object

    required

    name stringrequired
    email stringrequired
    date date-timerequired
    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 stringrequired

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

    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.

    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

    The CI provider used to create the build.

  • ]

    • pageable

    object

    required

    orderBy

    object[]

    required

  • Array [

    • ignoreCase booleanrequired
    direction Sort.Order.Direction (string)required

    Possible values: [ASC, DESC]

    property stringrequired
    ascending boolean

  • ]

    • number int32
    size int32required

    sort

    object

    required

    orderBy

    object[]

    required

  • Array [

    • ignoreCase booleanrequired
    direction Sort.Order.Direction (string)required

    Possible values: [ASC, DESC]

    property stringrequired
    ascending boolean

  • ]

    • pageNumber int32
    offset int64
    size int32
    empty boolean
    numberOfElements int32
    totalSize int64required
    totalPages int32
Loading...