Garoon API ドキュメント

お気に入りを取得する

目次

お気に入りの更新情報を取得する

固定リンクがコピーされました

お気に入りの更新情報を返すAPIです。

API名

固定リンクがコピーされました

StarGetStarVersions

利用できるバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

リクエスト

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
star_item base:ItemVersionType 0 ～ 無制限 取得するお気に入りのバージョン
例
1
2
3

<parameters>
  <star_item xmlns="" id="1" version="123"></star_item> 
</parameters>

レスポンス

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
star_item base:ItemVersionResultType 0 ～ 無制限 取得したお気に入りの更新情報
例
1
2
3
4

<returns>
  <star_item id="1" version="1286857750" operation="modify" /> 
  <star_item id="2" version="1286857836" operation="add" /> 
</returns>

お気に入りを取得する

固定リンクがコピーされました

お気に入りIDを指定して、お気に入りの詳細情報を取得するAPIです。 存在しないお気に入りIDを指定した場合は無視されます。

API名

固定リンクがコピーされました

StarGetStarsById

利用できるバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

リクエスト

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
star_id base:IDType 1 ～ 無制限 お気に入りID
例
1
2
3

<parameters> 
  <star_id xmlns="">1</star_id> 
</parameters>

レスポンス

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
star_data star:StarDataType 0 ～ 無制限 お気に入りの詳細情報
例
1
2
3
4

<returns>
  <star_data id="1" module_id="grn.report" item="2"
    subject="レポートタイトル" version="1286857750" /> 
</returns>