ここでは、APIで使用可能な各種データ型について解説します。

日時

REST APIインターフェースのタイムゾーンは、協定世界時(UTC+00:00)です。
ローカルタイムゾーンへの変換は、各自のアプリケーション内で行ってください。

日時の表現形式は、以下の通りです。

{"フィールド名":"YYYY-MM-DD HH:MM:SS"}

次のように時間を省略することも可能です。

{"フィールド名":"YYYY-MM-DD"}

例えば、「2014年1月1日 12時15分45秒」を指定する場合は、

{"フィールド名":"2014-01-01 12:15:45"}

とします。

ページ送りオブジェクト

ページ送りオブジェクトでは、取得されたリストデータの位置情報を表現します。
取得するリストを制御する方法については、こちらをご参照ください。

フィールド名説明
page 数値 現在のページNo
prevPage 数値 前のページNo
nextPage 数値 次のページNo
pageCount 数値 全ページ数
count 数値 全要素数
limit 数値 1ページあたりの出力要素数
order 文字列 ソート基準フィールド名
検索キーワードとの関連度順によるソートの場合は「*」
asc 真理値 ソート順
  • true: 昇順
  • false: 降順

{"paginate":{

    "page":現在のページNo,

    "prevPage":前のページNo,

    "nextPage":次のページNo,

    "pageCount":全ページ数,

    "count":全要素数,

    "limit":1ページあたりの出力要素数,

    "order":"ソート基準フィールド名",

    "asc":真理値(true/false)

}}

ACLオブジェクト

ACLオブジェクトは、メンバー(あるいはグループ)ごとのアクセス権限を表現します。

{"acl":{
    "*":{   /* すべてのメンバーに対するACL */
        "get":真理値(true/false),
        "list":真理値(true/false),
        "edit":真理値(true/false),
        "delete":真理値(true/false)
    },
    "メンバーインスタンスID":{
        "*":{   /* すべてのログインメンバーに対するACL */
            "get":真理値(true/false),
            "list":真理値(true/false),
            "edit":真理値(true/false),
            "delete":真理値(true/false)
        },
        "members":{

            "メンバーID":{   /* 特定のメンバーに対するACL */
                "get":真理値(true/false),
                "list":真理値(true/false),
                "edit":真理値(true/false),
                "delete":真理値(true/false)

            }
        },

        "groups":{

            "グループID":{   /* 特定のグループに属するメンバーに対するACL */
                "get":真理値(true/false),
                "list":真理値(true/false),
                "edit":真理値(true/false),
                "delete":真理値(true/false)

            }
        }


    }
}}

インスタンスポインタ

インスタンスポインタ型のフィールドには、異なるインスタンスのコンテンツを参照するポインタを関連付けることができます。

参照先がブログインスタンスの場合は、記事IDを指定します。

{"フィールド名":"記事ID"} 

参照先がデータベースインスタンスの場合は、レコードIDを指定します。

{"フィールド名":"レコードID"} 

参照先がメンバーインスタンスの場合は、メンバーIDを指定します。

{"フィールド名":"メンバーID"} 

メンバーターゲッティングオブジェクト

メールマガジンやプッシュ通知を配信する際、配信先メンバーの指定にメンバーターゲッティングオブジェクトを使用します。

{
    /* メンバーを個別指定 */
    "members":["メンバーID", ....],

    /* グループを個別指定 */
    "groups":["グループID", ....]
}

{
    /* 全メンバーを指定 */
    "members":"*"
}

{
    /* 最上位(ROOT)グループを指定 */
    "groups":"*"
}

端末インスタレーションオブジェクト

端末インスタレーションオブジェクトは、端末情報を表現するオブジェクトです。
プッシュ通知の配信端末を登録する際に使用します。

フィールド名説明
device_type 文字列 配信端末タイプ
ios: iOS系端末の場合
android: Android系端末の場合
device_token 文字列 端末を一意に識別するデバイストークン
  • iOS系端末の場合は、APNsから発行されるdeviceToken
  • Android系端末の場合は、GCMから発行されるRegistrationID

{"device_type":"配信端末タイプ", "device_token":"デバイストークン"}

ファイルデータ

ファイルデータ型のフィールドに、ローカルに存在するファイルをアップロードすることができます。

ファイルをアップロードする場合は、リクエストを次のように変更します。

リクエストメソッド
POST
リクエストヘッダー
Content-Type multipart/form-data
リクエストコンテント
method 本来のリクエストメソッドを指定します。
例えば、登録の場合は「POST」、変更の場合は「PUT」
data 本来のリクエストコンテントを指定します。