Using the CodePlex Web Services
CodePlex provides the following web services that can be used to automate portions of your project.
Release Service
Location (SSL is required) | https://www.codeplex.com/Services/ReleaseService.asmx |
SOAP Namespace | http://www.codeplex.com/services/ReleaseService/v1.0 |
Methods
CreateRelease
This method is deprecated. Please use
CreateARelease instead.
CreateARelease
Creates a new release in the specified project. The specified user must have permission to create a release in the project. The
name parameter must be unique within the project.
int CreateARelease(string projectName,
string name,
string description,
string releaseDate,
string status,
bool showToPublic,
bool isDefaultRelease,
string username,
string password)
Parameters Name | Type | Description |
projectName | string | The CodePlex project name. |
name | string | The name of the release. |
description | string | The description for the release. |
releaseDate | string | The date that the release was released. Must be a valid date for releases with a status other than Planning. For Planning releases, this value is ignored. |
status | string | The status of the release. Valid values are Planning, Alpha, Beta, Stable. |
showToPublic | bool | true if the release is visible to the public, false if the release should only be visible to Coordinators and Developers. |
isDefaultRelease | bool | true to mark the release as the default release for the project, false otherwise. If there is an existing default release, that release will no longer be the default. |
username | string | Your CodePlex username. |
password | string | Your CodePlex password. |
ReturnsAn integer value specifying the ID of the newly created release.
UploadReleaseFiles
This method is deprecated. Please use
UploadTheReleaseFiles instead.
UploadTheReleaseFiles
Adds one or more files to an existing release. The release is identified by the
releaseName parameter.
void UploadReleaseFiles(string projectName,
string releaseName,
ReleaseFile[] files,
string recommendedFileName,
string username,
string password)
Parameters Name | Type | Description |
projectName | string | The CodePlex project name. |
releaseName | string | The name of the release. |
files | ReleaseFile[] | An array of ReleaseFile objects describing the files to add to the release. |
recommendedFileName | string | The file name that should be marked as the recommended download. If null is supplied, the first file will be the recommended download. |
username | string | Your CodePlex username. |
password | string | Your CodePlex password. |
Types
ReleaseFile
Describes a release file.
class ReleaseFile
{
string Name;
string MimeType;
string FileName;
byte[] FileData;
string FileType;
}
Members Name | Type | Description |
Name | string | optional The display name for the file. If this is not specified, the FileName will be displayed. |
MimeType | string | optional The MIME type for the file. The default value is application/octet-stream. |
FileName | string | The file name for the file. If this is a full path, the path portion of the file name will be removed. |
FileData | byte[] | An array of byte values representing the file data. |
FileType | string | The type of file in the release. Valid values are RuntimeBinary, SourceCode, Documentation, Example. |