REST API Reference
ビルド
- Parameters
-
projectId
=プロジェクトID -
&
revision
=リビジョン -
&
author
=作成者
- Return
- XMLドキュメント
- Description
-
ビルドを要求します。
次の形式のXMLドキュメントを返します。
<status code="..." message="..." />
status要素の属性は次のようになります。
-
code
: 成功した場合は0、エラーの場合は−1 -
message
: 可読なメッセージ
-
ビルドログの取得
- Parameters
method=getBuildLog
-
&
projectId
=プロジェクトID -
&
serial
=シリアル -
&
platformCode
=プラットフォームコード - [
&
tail
=true]
- Return
- 成功した場合はHTMLドキュメント、そうでなければXMLドキュメント
- Description
-
ビルドログを取得します。
成功した場合はログをHTMLドキュメントとして返します。そうでない場合は次の形式のXMLドキュメントを返します。
<status code="-1" message="..." />
属性は次のようになります。
-
message
: 可読なメッセージ
-
ビルド一覧
- Parameters
method=listBuilds
-
&
projectId
=プロジェクトID - [
&
startKey
=開始シリアル]
- Return
- XMLドキュメント
- Description
-
ビルド一覧を取得します。startKeyが指定されていなけば最新のビルドを最大10件を取得します。startKeyが指定されている場合はstartKeyから最大10件取得します。
次の形式のXMLドキュメントを返します。
<status code="..." message="..."> <build serial="..." revision="..." author="..." date="..." status="..." /> ... <next serial="..." /> <prev serial="..." /> </status>
status要素の属性は次のようになります。
-
code
: 成功した場合は0、エラーの場合は−1 -
message
: 可読なメッセージ
build要素の属性は次のようになります。
-
serial
: シリアル -
revision
: リビジョン -
author
: 作成者 -
date
: 日付 -
status
: ステータス不明は0、成功は1、失敗は2
取得したビルド一覧に次のページ、前のページがある場合は、それぞれnext、prev要素が付加されます。next/prev要素の属性は次のようになります。
-
serial
: 次または前のページの開始位置となるstartKey。
-
ビルド詳細の取得
- Parameters
method=getBuildDetail
-
&
projectId
=プロジェクトID -
&
serial
=シリアル
- Return
- XMLドキュメント
- Description
-
ビルド詳細を取得します。
次の形式のXMLドキュメントを返します。
<status code="..." message="..."> <detail date="..." revision="..." author="..." status="..." /> <platform id="..." code="..." status="..." /> ... </status>
status要素の属性は次のようになります。
-
code
: 成功した場合は0、エラーの場合は−1 -
message
: 可読なメッセージ
detail要素の属性は次のようになります。
-
date
: 日付 -
revision
: リビジョン -
author
: 作成者 -
status
: ステータス不明は0、成功は1、失敗は2
platform要素の属性は次のようになります。
-
id
: プラットフォームID -
code
: プラットフォームコード(ビルドログの取得で使用する) -
status
: 成功は1、失敗は2
-
プロジェクトプロパティの取得
- Parameters
method=getProperty
-
&
projectId
=プロジェクトID
- Return
- XMLドキュメント
- Description
-
プロジェクトプロパティを取得します。
次の形式のXMLドキュメントを返します。
<status code="..." message="..."> <property description="..." mailEnabled="..." smtpServer="..." sender="..." receipient="..." /> <platform id="..." host="..." command="..." charset="..." /> ... </status>
status要素の属性は次のようになります。
-
code
: 成功した場合は0、エラーの場合は−1 -
message
: 可読なメッセージ
property要素の属性は次のようになります。
-
description
: プロジェクトの説明 -
mailEnabled
: メールで通知する場合は1、そうでなければ0 -
smtpServer
: 未使用 -
sender
: メールの送信元 -
receipient
: メールの宛先
platform要素の属性は次のようになります。
-
id
: プラットフォームID -
host
: ユーザ名@ホスト名 -
command
: リモートコマンドのパス -
charset
: ログの文字セット名(UTF-8, EUC-JPなど)
-
プロジェクトプロパティの設定
- Parameters
method=setProperty
-
&
projectId
=プロジェクトID -
&
projectConfig
=プロジェクトプロパティ
- Return
- XMLドキュメント
- Description
-
プロジェクトプロパティを設定します。
projectConfig
には次の形式のXMLドキュメントを指定します。<projectConfig> <property description="..." mailEnabled="..." smtpServer="..." sender="..." receipient="..." /> <platform id="..." host="..." command="..." charset="..." /> ... </projectConfig>
property要素の属性は次のようになります。
-
description
: プロジェクトの説明 -
mailEnabled
: メールで通知する場合は1、そうでなければ0 -
smtpServer
: 未使用 -
sender
: メールの送信元 -
receipient
: メールの宛先
platform要素の属性は次のようになります。
-
id
: プラットフォームID -
host
: ユーザ名@ホスト名 -
command
: リモートコマンドのパス -
charset
: ログの文字セット名(UTF-8, EUC-JPなど)
次の形式のXMLドキュメントを返します。
<status code="..." message="..." />
status要素の属性は次のようになります。
-
code
: 成功した場合は0、エラーの場合は−1 -
message
: 可読なメッセージ
-
プロジェクト一覧
- Parameters
method=listProjects
- Return
- XMLドキュメント
- Description
-
プロジェクト一覧を取得します。
次の形式のXMLドキュメントを返します。
<projectList> <project name="..." description="..." /> ... </projectList>
属性は次のようになります。
-
name
: プロジェクトID -
description
: プロジェクトの説明
-
プロジェクト作成
- Parameters
method=createProject
-
&
projectId
=プロジェクトID
- Return
- XMLドキュメント
- Description
-
プロジェクトを作成します。
次の形式のXMLドキュメントを返します。
<status code="..." message="..." />
status要素の属性は次のようになります。
-
code
: 成功した場合は0、エラーの場合は−1 -
message
: 可読なメッセージ
-
プロジェクト削除
- Parameters
method=deleteProject
-
&
projectId
=プロジェクトID
- Return
- XMLドキュメント
- Description
-
プロジェクトを削除します。
次の形式のXMLドキュメントを返します。
<status code="..." message="..." />
status要素の属性は次のようになります。
-
code
: 成功した場合は0、エラーの場合は−1 -
message
: 可読なメッセージ
-
公開鍵の取得
- Parameters
method=getPublicKey
- Return
- 成功した場合はHTMLドキュメント、そうでければXMLドキュメント
- Description
-
公開鍵を取得します。
成功した場合は公開鍵をHTMLドキュメントとして返します。そうでない場合は次の形式のXMLドキュメントを返します。
<status code="-1" message="..." />
属性は次のようになります。
-
message
: 可読なメッセージ
-