WebService::BitbucketServer::Build::V1 - Bindings for a Bitbucket Server REST API
version 0.600
my $stash = WebService::BitbucketServer->new( base_url => 'https://stash.example.com/', username => 'bob', password => 'secret', ); my $api = $stash->build;
This is a Bitbucket Server REST API for Build::V1.
Original API documentation created by and copyright Atlassian.
Get the instance of WebService::BitbucketServer passed to "new".
$api = WebService::BitbucketServer::Build::V1->new(context => $webservice_bitbucketserver_obj);
Create a new API.
Normally you would use $webservice_bitbucketserver_obj->build instead.
$webservice_bitbucketserver_obj->build
Produces a list of the build statistics for multiple commits.
Commits without any builds associated with them will not be returned. For example if the commit e00cf62997a027bbf785614a93e2e55bb331d268 does not have any build statuses associated with it, it will not be present in the response.
e00cf62997a027bbf785614a93e2e55bb331d268
POST build-status/1.0/commits/stats
Responses:
200 - data, type: application/json
200
The number of successful/failed/in-progress builds for each commit (with the caveat that the commits without any builds associated with them will not be present in the response)
401 - errors, type: application/json
401
The user is not authenticated or does not have the LICENSED permission.
Gets statistics regarding the builds associated with a commit.
GET build-status/1.0/commits/stats/{commitId}
Parameters:
commitId - string, default: none
commitId
full SHA1 of the commit (ex: e00cf62997a027bbf785614a93e2e55bb331d268)
includeUnique - boolean, default: false
includeUnique
include a unique build result if there is either only one failed build, only one in-progress build or only one successful build
The number of successful/failed/in-progress builds for the commit
Gets the build statuses associated with a commit.
GET build-status/1.0/commits/{commitId}
a page of build statuses associated with the commit (limited to the most recent 100 build statuses associated with the commit)
Associates a build status with a commit.
The state, the key and the url are mandatory. The name and description fields are optional.
state
key
url
name
description
All fields (mandatory or optional) are limited to 255 characters, except for the url, which is limited to 450 characters.
Supported values for the state are SUCCESSFUL, FAILED and INPROGRESS.
SUCCESSFUL
FAILED
INPROGRESS
The authenticated user must have LICENSED permission or higher to call this resource.
POST build-status/1.0/commits/{commitId}
400 - errors, type: application/json
400
An error message if the commitId if not a full 40-characters SHA1, if the build status has a missing mandatory field or if the fields are too large
204 - data, type: unknown
204
An empty response if the build status was successfully stored
WebService::BitbucketServer
https://developer.atlassian.com/bitbucket/server/docs/latest/
Please report any bugs or feature requests on the bugtracker website https://github.com/chazmcgarvey/WebService-BitbucketServer/issues
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
Charles McGarvey <ccm@cpan.org>
This software is copyright (c) 2017 by Charles McGarvey.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install WebService::BitbucketServer, copy and paste the appropriate command in to your terminal.
cpanm
cpanm WebService::BitbucketServer
CPAN shell
perl -MCPAN -e shell install WebService::BitbucketServer
For more information on module installation, please visit the detailed CPAN module installation guide.