モジュール名: project

機能名	説明
list	プロジェクトの一覧を取得します
register	プロジェクトを登録します
unregister	プロジェクトの登録を解除します

機能名: list

説明

ログインユーザーのプロジェクト一覧を取得します。
フロー名は表示されません。

リクエスト

HTTPメソッド	リクエストURL
GET	`http://{Hostname}:{Port}/api/project/list`

リクエストパラメーター

パラメーター	必須	説明
filter	いいえ	一覧の結果をプロジェクト名でフィルターしたい場合は、フィルターしたいプロジェクト名の一部を指定します。
owner	いいえ	一覧で取得するプロジェクトのオーナーを指定します。省略時はログインユーザーになります。

リクエスト例

GET /api/project/list HTTP/1.1
X-Fs-SessionId: F15B47BC1F004DB489BAF1E4CDD0100D

レスポンス

HTTPステータスコード

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

実行結果

実行に成功するとプロジェクトの一覧が返ります。
プロジェクトの情報としては次の情報が取得できます。

プロジェクト名
プロジェクトオーナー名
プロジェクトキャッシュの状態
キャッシュされている場合は「true」、キャッシュされていない場合は「false」

<result>
	<status>success</status>
	<data>
		<project>
			<name>Project1</name>
			<owner>/guest</owner>
			<cache>true</cache>
		</project>
		<project>
			<name>Project2</name>
			<owner>/guest</owner>
			<cache>true</cache>
		</project>
	</data>
</result>

エラーケース

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

エラーコード	HTTPステータスコード	説明
2001	403 Forbidden	ログインしていなかった場合指定したownerに対しての権限がない場合

▲ このページのトップへ

機能名: register

説明

指定のプロジェクトファイル（xfpファイル）を登録します。
すでにサーバー上にプロジェクトファイルが置かれている場合のみ登録することができます。

リクエスト

HTTPメソッド	リクエストURL
POST	`http://{Hostname}:{Port}/api/project/register`

リクエストパラメーター

パラメーター	必須	説明
projectFile	はい	登録するプロジェクトのプロジェクトファイル（xfpファイル）名を指定します。ホームフォルダーのサブフォルダに存在するプロジェクトファイルを指定する場合は、ホームフォルダーからの相対パスで指定します。例えば、サブフォルダ「test」の中に存在する「Project2.xfp」を指定する場合は、「projectFile=test/Project2.xfp」と指定します。

リクエスト例

POST /api/project/register HTTP/1.1
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
X-Fs-SessionId: F15B47BC1F004DB489BAF1E4CDD0100D
Content-Length: 24

projectFile=Project1.xfp

レスポンス

HTTPステータスコード

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

実行結果

実行に成功しても特に情報は返りません。

<result>
	<status>success</status>
	<data></data>
</result>

エラーケース

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

エラーコード	HTTPステータスコード	説明
2000	400 Bad Request	projectFileパラメーターが存在しなかった場合
2001	403 Forbidden	ログインしていなかった場合
2002	404 Not Found	指定したプロジェクトファイルが存在しなかった場合
2004	409 Conflict	プロジェクト名が重複しているなどの理由でプロジェクトの登録ができなかった場合

▲ このページのトップへ

機能名: unregister

説明

指定のプロジェクトを登録解除します。
そのプロジェクトの実行設定もすべて解除されます。
登録解除を行ってもxfpファイルは削除されません。

リクエスト

HTTPメソッド	リクエストURL
POST	`http://{Hostname}:{Port}/api/project/unregister`

リクエストパラメーター

パラメーター	必須	説明
project	はい	登録解除するプロジェクトのプロジェクト名を指定します。プロジェクトの登録（register）時にはプロジェクトファイル名を指定しますが、登録解除時にはプロジェクト名を指定します。

リクエスト例

POST /api/project/unregister HTTP/1.1
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
X-Fs-SessionId: F15B47BC1F004DB489BAF1E4CDD0100D
Content-Length: 16

project=Project1

レスポンス

HTTPステータスコード

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

実行結果

実行に成功しても特に情報は返りません。

<result>
	<status>success</status>
	<data></data>
</result>

エラーケース

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

エラーコード	HTTPステータスコード	説明
2000	400 Bad Request	projectパラメーターが存在しなかった場合
2001	403 Forbidden	ログインしていなかった場合
2004	409 Conflict	プロジェクトが存在していなかったなどの理由でプロジェクトの登録解除ができなかった場合

▲ このページのトップへ