Garoon APIドキュメント

ベースAPIで使用するデータの構造

目次

ItemVersionType

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

データ項目の更新日時を表す型です。 データ項目の更新情報を取得するために使用されます。データ項目を表すIDをパラメーターとして持ちます。

使用可能なGaroonのバージョン

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

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

データ構造

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

パラメーター名 型 パラメーター数 説明
@id base:IDType 1 データ項目のID
@version base:VersionType 1 バージョン情報

ItemVersionResultType

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

データ項目の更新情報を表す型です。 更新時に行われた操作をパラメーターとして持ちます。 この型はレスポンスのみで使用されます。

使用可能なGaroonのバージョン

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

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

リクエスト

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

パラメーター名 型 パラメーター数 説明
@id base:IDType 1 データ項目のID
@version base:VersionType 1 バージョン情報
@operation base:ItemOperationType 1 行われた操作

ItemOperationType

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

データ項目への操作を表す型です。

使用可能なGaroonのバージョン

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

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

データ構造

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

この型は単一の文字列を表すスカラー値です。また、この型が取り得る値は次のいずれかです。

値 説明
add 追加されたことを表す
modify 変更されたことを表す
remove 削除されたことを表す

UserType

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

ユーザー情報の詳細（カスタマイズ項目を除く）を表す型です。

使用可能なGaroonのバージョン

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

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

データ構造

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

パラメーター名 型 パラメーター数 説明
photo 配列 0～1
0：画像が存在しない
1：画像が存在する		 ユーザーの画像
photo/@file_id base:IDType 1 ユーザー画像のファイルID
photo/@version base:VersionType 1 ユーザー画像の更新日時
photo/@name base:NonBlankStringType 1 ユーザー画像の名前
photo/@size xsd:unsignedLong 0～1 ユーザー画像のファイルサイズ
photo/@mime_type xsd:string 0～1 ユーザー画像のMIMEタイプ
organization 配列 0～ 無制限
0：所属する組織が存在しない
1～：所属する組織が存在する		 ユーザーが所属する組織
organization/@id base:IDType 1 所属する組織のID
@key base:IDType 1 GaroonユーザーID
@version base:VersionType 1 ユーザー情報の更新日時
@order xsd:unsignedLong 0～1 ユーザーの表示優先度。指定されていない場合、システムが扱える最大値（2147483647）になります。
@name xsd:string 1 ユーザーの名前
@login_name xsd:string 0～1 ユーザーのログイン名
@status xsds:byte 1 ユーザーの使用状況- 0：使用中
- 1：使用停止
- 2：削除
@reading xsd:string 0～1
0：よみが指定されていない
1：よみが指定されている		 ユーザーの名前のよみ
@url xsd:string 0～1
0：URLが指定されていない
1：URLが指定されている		 ユーザーのURL
@email xsd:string 0～1
0：E-mailアドレスが指定されていない
1：E-mailアドレスが指定されている		 ユーザーのE-mailアドレス
@phone xsd:string 0～1
0：連絡先が指定されていない
1：連絡先が指定されている		 ユーザーの連絡先
@title xsd:string 0～1
0：役職が指定されていない
1：役職が指定されている		 ユーザーの役職
@description xsd:string 0～1
0：メモが指定されていない
1：メモが指定されている		 ユーザーのメモ
@primary_organization base:IDType 0～1
0：優先する組織が指定されていない
1：優先する組織が指定されている		 ユーザーの優先する組織のID

NonBlankStringType

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

長さが1以上の文字列を表す型です。

使用可能なGaroonのバージョン

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

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

IDType

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

データのIDを表す型です。このタイプはNonBlankStringTypeと同一です。

使用可能なGaroonのバージョン

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

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

VersionType

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

バージョンを表す型です。このタイプはNonBlankStringTypeと同一です。

使用可能なGaroonのバージョン

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

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

BaseApplicationStatusType

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

Garoonのアプリケーションの状態を表す型です。

使用可能なGaroonのバージョン

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

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

データ構造

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

この型は単一の文字列を表すスカラー値です。また、この型が取り得る値は次のいずれかです。

値 説明
active アプリケーションが使用中状態
deactive アプリケーションが使用停止状態
license_expired アプリケーションのライセンスが切れて、使用できない状態

BaseApplicationType

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

アプリケーションのコードと状態を表す型です。

使用可能なGaroonのバージョン

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

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

データ構造

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

パラメーター名 型 パラメーター数 説明
@code base:NonBlankStringType 1 アプリケーションのコード
@status base:BaseApplicationStatusType 1 アプリケーションの状態

BaseApplicationInformationType

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

アプリケーションの使用状態とシンク許可状態を表す型です。

使用可能なGaroonのバージョン

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

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

データ構造

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

パラメーター名 型 パラメーター数 説明
@module_id base:IDType 1 アプリケーションID
@name base:NonBlankStringType 1 アプリケーション名
@url xsd:anyURL 0～1 アプリケーションURL
@available_feature xsd:positiveInteger 1 アプリケーションの使用状態
available_client - 0～ 無制限 シンクの許可状態

BaseManagerApplicationType

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

アプリケーションの状態管理時に使用する型です。

使用可能なGaroonのバージョン

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

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

データ構造

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

パラメーター名 型 パラメーター数 説明
@code xsd:string 1 アプリケーションのコード
@status xsd:boolean 1 アプリケーションの状態- true：使用中
- false：停止中

BaseGetCalendarEventType

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

カレンダーに登録されたイベントを表す型です。

使用可能なGaroonのバージョン

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

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

データ構造

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

パラメーター名 型 パラメーター数 説明
@date xsd:date 1 イベントの日付
@content xsd:string 1 イベントの内容
@type base:BaseGetCalendarEventTypeType 1 イベントの種別

BaseGetCalendarEventTypeType

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

カレンダーに登録されたイベントの種別を表す型です。

使用可能なGaroonのバージョン

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

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

データ構造

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

この型は単一の文字列を表すスカラー値です。また、この型が取り得る値は次のいずれかです。

値 説明
public_holiday イベントタイプが「祝日」の予定。システム管理画面からのみ登録可能。
memorial_holiday イベントタイプが「記念日」の予定。個人設定からのみ登録可能。
system_memo システム管理画面から登録されたメモを表す。
user_memo 個人設定から登録されたメモを表す。

ChangeLogType

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

ユーザー情報を表す型です。

使用可能なGaroonのバージョン

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

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

データ構造

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

パラメーター名 型 パラメーター数 説明
@user_id base:IDType 1 GaroonユーザーID
@name base:NonBlankStringType 1 ユーザー名
@date xsd:dateTime 1 日時

OrganizationType

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

ひとつの組織を表す型です。 組織は子組織をもつ木構造になるため、OrganizationTypeは子にOrganizationTypeを持ちます。

使用可能なGaroonのバージョン

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

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

データ構造

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

パラメーター名 型 パラメーター数 説明
@key base:IDType 1 組織のID
@name base:IDType 1 組織名
@version base:VersionType 1 バージョン
@description xsd:string 0～1 メモ
@order xsd:integer 0～1 表示順序
@parent_organization base:IDType 0〜1 親組織ID
organization base:OrganizationType 0～ 無制限 子組織
members base:MembersType 0～1 組織に所属するユーザー一覧

BaseMyGroupType

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

Myグループを表す型です。

使用可能なGaroonのバージョン

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

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

データ構造

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

パラメーター名 型 パラメーター数 説明 変更履歴
@key base:IDType 1 MyグループのID
@name base:IDType 1 Myグループ名
@version base:VersionType 1 バージョン
@description xsd:string 0～1 メモ
@order xsd:unsignedLong 0～1 表示順序
belong_member base:IDType 0～ 無制限 Myグループの参加者ID
belong_facility base:IDType 0～ 無制限 Myグループの施設ID パッケージバージョン4.6.0で追加

MembersType

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

メンバー一覧を表すクラスです。

使用可能なGaroonのバージョン

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

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

データ構造

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

パラメーター名 型 パラメーター数 説明
user - 0～ 無制限 ユーザー
user/@id base:IDType 1 GaroonユーザーID

RegionType

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

リージョンを表す型です。

使用可能なGaroonのバージョン

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

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

データ構造

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

パラメーター名 型 パラメーター数 説明
@name xsd:string 0～1 リージョン名
city - 0～ 無制限 タイムゾーン情報
city/@name xsd:string 0～1 都市名
city/@timezone xsd:string 0～1 タイムゾーン名

FileType

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

ユーザー情報の画像ファイルを表す型です。

使用可能なGaroonのバージョン

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

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

データ構造

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

パラメーター名 型 パラメーター数 説明
content/text() xsd:base64Binary 1 ファイルデータ
@id base:IDType 1 ファイルID
@version base:VersionType 1 バージョン
@name xsd:string 1 ファイル名
@size xsd:unsignedLong 0～1 ファイルサイズ
@mime_type xsd:string 0～1 ファイルのMIMEタイプ

FileBodyType

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

ファイルを表す型です。

使用可能なGaroonのバージョン

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

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

データ構造

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

パラメーター名 型 パラメーター数 説明
content/text() xsd:base64Binary 1 ファイルデータ