モジュール名: svn

機能名 説明
list バージョン管理の変更チェック対象ファイルリストを取得します
log バージョン管理のlogコマンドを実行し、リポジトリの履歴を取得します
update バージョン管理のupdateコマンドを実行し、リポジトリの指定のリビジョンで更新します

機能名: list

説明

バージョン管理の変更チェック対象ファイルリストを取得します。

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/api/svn/list
リクエストパラメーター
パラメーター 必須 説明
path いいえ 変更チェック対象ファイルを取得するフォルダーを指定します。
省略時はホームフォルダーが対象になります。
リクエスト例
GET /api/svn/list HTTP/1.1
X-Fs-SessionId: F15B47BC1F004DB489BAF1E4CDD0100D
レスポンス
HTTPステータスコード

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行結果

実行に成功するとファイルの一覧が返ります。
ファイルの情報としては次の情報が取得できます。 

<result>
	<status>success</status>
	<data>
		<list>
			<relativePath>Project1.xfp</relativePath>
			<status>normal</status>
			<remoteStatus>unversioned</remoteStatus>
			<lockOwner>testUser</lockOwner>
			<lockComment>Update for bug001</lockComment>
			<author>guest</author>
			<workingRevision>3</workingRevision>
			<committedRevision></committedRevision>
			<date>2014-04-25 19:56:17</date>
		</list>
	</data>
</result>
エラーケース

下記以外のエラーについては、共通エラーコードを参照してください。

エラーコード HTTPステータスコード 説明
2001 403 Forbidden ログインしていなかった場合
9000 500 Internal Server Error バージョン管理サーバーに接続できなかった場合
バージョン管理コマンドの実行に失敗した場合

▲ このページのトップへ

機能名: log

説明

バージョン管理のlogコマンドを実行し、リポジトリの履歴を取得します。

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/api/svn/log
リクエストパラメーター
パラメーター 必須 説明
path いいえ 履歴を取得するファイルまたはフォルダーを指定します。
省略時はホームフォルダーが対象になります。
revision いいえ 履歴の取得を開始するリビジョンを指定します。
リビジョン番号または日付（yyyy-MM-dd形式）を指定します。
省略時は最新リビジョンからの履歴になります。
「change」パラメーターと同時に指定された場合は、「revision」パラメーターが優先されます。
change いいえ 履歴を取得するリビジョンを指定します。
指定された場合はそのリビジョンのみの情報が表示されます。
リビジョン番号または日付（yyyy-MM-dd形式）を指定します。
「revesion」パラメーターと同時に指定された場合は、「revision」パラメーターが優先されます。
stopOnCopy いいえ コピー以前の履歴を取得しない場合は「true」を指定します。
省略時は「false」（すべての履歴を取得）となります。
limit いいえ 取得する履歴の数の最大値を指定します。
省略時は100となります。
リクエスト例
GET /api/svn/log HTTP/1.1
X-Fs-SessionId: F15B47BC1F004DB489BAF1E4CDD0100D
レスポンス
HTTPステータスコード

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行結果

実行に成功すると履歴の一覧が返ります。
履歴の情報としては次の情報が取得できます。 

<result>
	<status>success</status>
	<data>
		<log>
			<revision>270</revision>
			<author>svnuser</author>
			<date>2012-09-25 19:56:17</date>
			<comment>Change Flow1</comment>
			<changes>
				<change>
					<type>M</type>
					<path>Project1.xfp</path>
					<copypath>test/Project2.xfp</copypath>
					<copyrevision>268</copyrevision>
				</change>
			</changes>
		</log>
		<log>
			<revision>269</revision>
			<author>svnuser</author>
			<date>2012-09-25 18:39:51</date>
			<comment>Add 2 projects</comment>
			<changes>
				<change>
					<type>A</type>
					<path>Project1.xfp</path>
					<copypath></copypath>
					<copyrevision></copyrevision>
				</change>
				<change>
					<type>A</type>
					<path>Project2.xfp</path>
					<copypath></copypath>
					<copyrevision></copyrevision>
				</change>
			</changes>
		</log>
	</data>
</result>
エラーケース

下記以外のエラーについては、共通エラーコードを参照してください。

エラーコード HTTPステータスコード 説明
2001 403 Forbidden ログインしていなかった場合
9000 500 Internal Server Error バージョン管理サーバーに接続できなかった場合
バージョン管理コマンドの実行に失敗した場合

▲ このページのトップへ

機能名: update

説明

バージョン管理のupdateコマンドを実行し、リポジトリの指定のリビジョンで更新します。

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/api/svn/update
リクエストパラメーター
パラメーター 必須 説明
path いいえ 更新を行うファイルまたはフォルダーを指定します。
省略時はホームフォルダーが対象になります。
revision いいえ 更新するリビジョンを指定します。
リビジョン番号または日付（yyyy-MM-dd形式）を指定します。
省略時は最新リビジョンで更新します。
recursive いいえ 子フォルダーを更新対象としない場合は「false」を指定します。
省略時は「true」（子フォルダーを更新対象とする）となります。
force いいえ ローカルで変更のあるファイルも強制的に更新する場合は「true」を指定します。
省略時は「false」（ローカルで変更のあるファイルは更新しない）となります。
リクエスト例
POST /api/svn/update HTTP/1.1
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
X-Fs-SessionId: F15B47BC1F004DB489BAF1E4CDD0100D
Content-Length: 10

force=true
レスポンス
HTTPステータスコード

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行結果

実行に成功すると更新したリビジョン番号が返ります。

<result>
	<status>success</status>
	<data>
		<revision>270</revision>
	</data>
</result>
エラーケース

下記以外のエラーについては、共通エラーコードを参照してください。

エラーコード HTTPステータスコード 説明
2001 403 Forbidden ログインしていなかった場合
9000 500 Internal Server Error バージョン管理サーバーに接続できなかった場合
バージョン管理コマンドの実行に失敗した場合

▲ このページのトップへ