バージョン: 1
| 操作 | 説明 |
|---|---|
| POST /{applicationId}/collections/{collectionId}/attachments | 添付ファイルを作成 |
| GET /{applicationId}/collections/{collectionId}/attachments/{attachmentId} | 添付ファイルを取得 |
| 操作 | 説明 |
|---|---|
| GET /{applicationId}/users | ユーザーのリストを取得 |
| POST /{applicationId}/users/{userId}/notifications | プッシュ通知を送信 |
| 操作 | 説明 |
|---|---|
| GET /{applicationId} | アプリケーション定義を取得 |
| 操作 | 説明 |
|---|---|
| GET /{applicationId}/management/users | ユーザーのリストを取得 |
| POST /{applicationId}/management/users | ユーザーを作成 |
| GET /{applicationId}/management/users/{userId} | ユーザーを取得 |
| PUT /{applicationId}/management/users/{userId} | ユーザーを更新 |
| DELETE /{applicationId}/management/users/{userId} | ユーザーを削除 |
Bearer認証。トークンIDと秘密トークンを.で繋いだものを、Bearerトークンとして使用します。
ベーシック認証。あなたのユーザーIDをユーザー名として、あなたのパスワードをパスワードとして使用します。
アプリケーションの定義を、コレクション・カラムの定義とともに取得します。
| applicationId | アプリケーションのID。 |
パス | string , 以下にマッチ ^p[a-z0-9]{26}$ |
application/json
アプリケーション定義を取得しました。レスポンス本体は、取得したアプリケーション定義です。
幾つかのパラメーターが不正です。
ユーザー認証に失敗しました。
リクエストが許可されていません。
幾つかのリソースが見つかりませんでした。
リクエスト数の制限に達しました。
サーバー上で問題が発生しました。
| Bearer | |
| Basic |
指定されたコレクションに添付ファイルを作成します。
*/*
リクエスト本体には、添付ファイルのバイナリストリームを渡します。
添付ファイルのバイナリストリーム。
| applicationId | アプリケーションのID。 |
パス | string , 以下にマッチ ^p[a-z0-9]{26}$ | |
| collectionId | コレクションのID。 |
パス | string , 以下にマッチ ^t[a-z0-9]{7}$ | |
| Content-Disposition | 添付ファイルのContent-Disposition。 |
ヘッダー | string | |
| Content-Type | 添付ファイルのContent-Type。任意のContent-Typeが指定できます。指定されない場合には、 |
ヘッダー | string application/octet-stream | |
| X-Platio-CreatorId | 添付ファイルの作成者のユーザーID。このパラメーターを指定するには、あなたが管理者ユーザーである必要があります。指定しない場合、あなたが作成者になります。 |
ヘッダー | string , 以下にマッチ ^u[a-z0-9]{7}$ |
application/json
添付ファイルが作成されました。レスポンス本体は、作成された添付ファイルのメタデータです。
幾つかのパラメーターが不正です。
ユーザー認証に失敗しました。
リクエストが許可されていません。
幾つかのリソースが見つかりませんでした。
リクエスト数の制限に達しました。
サーバー上で問題が発生しました。
| Bearer | |
| Basic |
指定されたIDの添付ファイルを取得します。
| applicationId | アプリケーションのID。 |
パス | string , 以下にマッチ ^p[a-z0-9]{26}$ | |
| collectionId | コレクションのID。 |
パス | string , 以下にマッチ ^t[a-z0-9]{7}$ | |
| attachmentId | 添付ファイルのID。 |
パス | string , 以下にマッチ ^a[a-z0-9]{26}$ |
*/*
添付ファイルを取得しました。レスポンス本体は、添付ファイルのバイナリストリームです。
| Cache-Control | string | |
| ETag | string | |
| Last-Modified | string | |
| Content-Type | string | |
| Content-Disposition | string |
添付ファイルは変更されていません。
幾つかのパラメーターが不正です。
ユーザー認証に失敗しました。
リクエストが許可されていません。
幾つかのリソースが見つかりませんでした。
リクエスト数の制限に達しました。
サーバー上で問題が発生しました。
| Bearer | |
| Basic |
指定されたコレクションのレコードを削除します。パラメーターの指定により、どのレコードを削除するかを指定することができます。
| applicationId | アプリケーションのID。 |
パス | string , 以下にマッチ ^p[a-z0-9]{26}$ | |
| collectionId | コレクションのID。 |
パス | string , 以下にマッチ ^t[a-z0-9]{7}$ | |
| search | 検索条件。例えば、 |
クエリパラメーター | string | |
| timezone | 検索条件内で指定された日時のタイムゾーン。例えば、 |
クエリパラメーター | string アプリケーションのタイムゾーン | |
| limit | 削除するレコードの最大数。 |
クエリパラメーター | integer , { x ∈ ℤ | x ≤ 100000 } 100000 |
レコードが削除されました (limitを指定した場合)。
{
"deletedCount": 3453
}
削除されたレコードの数。
レコードが削除されました (limitを指定しない場合)。
幾つかのパラメーターが不正です。
ユーザー認証に失敗しました。
リクエストが許可されていません。
幾つかのリソースが見つかりませんでした。
リクエスト数の制限に達しました。
サーバー上で問題が発生しました。
| Bearer | |
| Basic |
指定されたコレクションのレコードのリストを取得します。パラメーターの指定により、どのレコードを取得するかを指定することができます。
| applicationId | アプリケーションのID。 |
パス | string , 以下にマッチ ^p[a-z0-9]{26}$ | |
| collectionId | コレクションのID。 |
パス | string , 以下にマッチ ^t[a-z0-9]{7}$ | |
| skip | 読み飛ばすレコードの数。 |
クエリパラメーター | integer | |
| limit | 取得するレコードの数。 |
クエリパラメーター | integer , { x ∈ ℤ | x ≤ 100 } 100 | |
| sortKey | レコードをソートするキー。 |
クエリパラメーター | string , x ∈ { column , createdAt , updatedAt (デフォルト) , createdBy , updatedBy } | |
| sortOrder | レコードをソートする向き。 |
クエリパラメーター | string , x ∈ { ascending , descending (デフォルト) } | |
| sortColumnId | レコードをソートするカラムのID。 |
クエリパラメーター | string , 以下にマッチ ^c[a-z0-9]{7}$ | |
| search | 検索条件。例えば、 |
クエリパラメーター | string | |
| timezone | 検索条件内で指定された日時のタイムゾーン。例えば、 |
クエリパラメーター | string アプリケーションのタイムゾーン |
application/json
レコードのリストを取得しました。レスポンス本体は、取得したレコードの配列です。
幾つかのパラメーターが不正です。
ユーザー認証に失敗しました。
リクエストが許可されていません。
幾つかのリソースが見つかりませんでした。
リクエスト数の制限に達しました。
サーバー上で問題が発生しました。
| Bearer | |
| Basic |
指定した値を使用して、指定したコレクションにレコードを作成します。
application/json
リクエスト本体には、レコードを作成するためのパラメーターをJSONオブジェクト・配列形式で指定します。
レコードを作成するためのパラメーターを含むオブジェクト、または、この形式のオブジェクトを複数含む配列。
{
"creatorId": "ue66a6a4",
"values": {
"c3838801": {
"id": "u0cfddaf",
"name": "user2",
"type": "User"
},
"c5112dee": {
"type": "Boolean",
"value": true
},
"cb9585ae": {
"type": "Date",
"value": "2016-05-15T00:00:00.000Z"
},
"cc864ba9": {
"type": "String",
"value": "String value"
}
}
}
カラムIDから値へのマッピング。詳細については、 https://doc.plat.io/api/ja/values.html を参照してください。
レコードの作成者のユーザーID。このパラメーターを指定するには、あなたが管理者ユーザーである必要があります。指定しない場合、あなたが作成者になります。
| applicationId | アプリケーションのID。 |
パス | string , 以下にマッチ ^p[a-z0-9]{26}$ | |
| collectionId | コレクションのID。 |
パス | string , 以下にマッチ ^t[a-z0-9]{7}$ |
application/json
レコードが作成されました。レスポンス本体は、作成されたレコードです。
幾つかのパラメーターが不正です。
ユーザー認証に失敗しました。
リクエストが許可されていません。
幾つかのリソースが見つかりませんでした。
リクエスト数の制限に達しました。
サーバー上で問題が発生しました。
| Bearer | |
| Basic |
指定した値を使用して、指定されたコレクションの複数のレコードを更新します。
application/json
リクエスト本体には、レコードを更新するためのパラメーターを配列形式で指定します。
レコードを更新するためのパラメーターを含む配列。
[
{
"id": "rwyfzcbdj2vb5rbsebyp3f42zvi",
"values": {
"c3838801": {
"id": "u0cfddaf",
"name": "user2",
"type": "User"
},
"c5112dee": {
"type": "Boolean",
"value": true
},
"cb9585ae": {
"type": "Date",
"value": "2016-05-15T00:00:00.000Z"
},
"cc864ba9": {
"type": "String",
"value": "String value"
}
}
},
{
"id": "refo5otf6fbb2lhgnwvhbc7jg5i",
"replace": false,
"values": {
"c3838801": {
"id": "u77e8bc9",
"name": "user1",
"type": "User"
},
"c5112dee": {
"type": "Boolean",
"value": false
},
"cb9585ae": {
"type": "Date",
"value": "2019-09-15T00:00:00.000Z"
},
"cc864ba9": {
"type": "String",
"value": "String value 2"
}
}
}
]
レコードのID。
カラムIDから値へのマッピング。詳細については、 https://doc.plat.io/api/ja/values.html を参照してください。
全ての値を置き換えるかどうかを指定するフラグ。falseを指定すると、valuesで指定された値のみを更新します。値を削除するには、valuesの対応する値にnullを指定します。trueまたは指定しない場合には、全ての値を更新します。
| applicationId | アプリケーションのID。 |
パス | string , 以下にマッチ ^p[a-z0-9]{26}$ | |
| collectionId | コレクションのID。 |
パス | string , 以下にマッチ ^t[a-z0-9]{7}$ |
application/json
複数のレコードが更新されました。レスポンス本体は、更新されたレコードの配列です。
幾つかのパラメーターが不正です。
ユーザー認証に失敗しました。
リクエストが許可されていません。
幾つかのリソースが見つかりませんでした。
リクエスト数の制限に達しました。
サーバー上で問題が発生しました。
| Bearer | |
| Basic |
指定したカラムの値が同じレコードを更新します。レコードが見つからなかった場合には、新しいレコードを作成します。
リクエスト本体には、レコードをUpsertするためのパラメーターを、JSONオブジェクト形式または、オブジェクトを含むJSON配列形式で指定します。
レコードをUpsertするためのパラメーターを含むオブジェクトまたは、この形式のオブジェクトを含む配列。
{
"creatorId": "ue66a6a4",
"values": {
"c3838801": {
"id": "u0cfddaf",
"name": "user2",
"type": "User"
},
"c5112dee": {
"type": "Boolean",
"value": true
},
"cb9585ae": {
"type": "Date",
"value": "2016-05-15T00:00:00.000Z"
},
"cc864ba9": {
"type": "String",
"value": "String value"
}
}
}
| applicationId | アプリケーションのID。 |
パス | string , 以下にマッチ ^p[a-z0-9]{26}$ | |
| collectionId | コレクションのID。 |
パス | string , 以下にマッチ ^t[a-z0-9]{7}$ | |
| upsertKeyColumnId | キーにするカラムのID。指定されたカラムは、値の重複を許さず、検索可能である必要があります。 |
パス | string , 以下にマッチ ^c[a-z0-9]{7}$ |
application/json
レコードがUpsertされました。レスポンス本体は、Upsertされたレコードです。
幾つかのパラメーターが不正です。
ユーザー認証に失敗しました。
リクエストが許可されていません。
幾つかのリソースが見つかりませんでした。
リクエスト数の制限に達しました。
サーバー上で問題が発生しました。
| Bearer | |
| Basic |
指定されたレコードを削除します。
| applicationId | アプリケーションのID。 |
パス | string , 以下にマッチ ^p[a-z0-9]{26}$ | |
| collectionId | コレクションのID。 |
パス | string , 以下にマッチ ^t[a-z0-9]{7}$ | |
| recordId | レコードのID。 |
パス | string , 以下にマッチ ^r[a-z0-9]{26}$ |
レコードが削除されました。
幾つかのパラメーターが不正です。
ユーザー認証に失敗しました。
リクエストが許可されていません。
幾つかのリソースが見つかりませんでした。
リクエスト数の制限に達しました。
サーバー上で問題が発生しました。
| Bearer | |
| Basic |
指定されたコレクションにある、指定されたIDのレコードを取得します。
| applicationId | アプリケーションのID。 |
パス | string , 以下にマッチ ^p[a-z0-9]{26}$ | |
| collectionId | コレクションのID。 |
パス | string , 以下にマッチ ^t[a-z0-9]{7}$ | |
| recordId | レコードのID。 |
パス | string , 以下にマッチ ^r[a-z0-9]{26}$ |
application/json
レコードを取得しました。レスポンス本体は、取得したレコードです。
幾つかのパラメーターが不正です。
ユーザー認証に失敗しました。
リクエストが許可されていません。
幾つかのリソースが見つかりませんでした。
リクエスト数の制限に達しました。
サーバー上で問題が発生しました。
| Bearer | |
| Basic |
指定した値を使用して、指定されたレコードを更新します。
application/json
リクエスト本体には、レコードを更新するためのパラメーターをJSON形式で指定します。
レコードを更新するためのパラメーターを含むオブジェクト。
{
"values": {
"c3838801": {
"id": "u0cfddaf",
"name": "user2",
"type": "User"
},
"c5112dee": {
"type": "Boolean",
"value": true
},
"cb9585ae": {
"type": "Date",
"value": "2016-05-15T00:00:00.000Z"
},
"cc864ba9": {
"type": "String",
"value": "String value"
}
}
}
カラムIDから値へのマッピング。詳細については、 https://doc.plat.io/api/ja/values.html を参照してください。
全ての値を置き換えるかどうかを指定するフラグ。falseを指定すると、valuesで指定された値のみを更新します。値を削除するには、valuesの対応する値にnullを指定します。trueまたは指定しない場合には、全ての値を更新します。
| applicationId | アプリケーションのID。 |
パス | string , 以下にマッチ ^p[a-z0-9]{26}$ | |
| collectionId | コレクションのID。 |
パス | string , 以下にマッチ ^t[a-z0-9]{7}$ | |
| recordId | レコードのID。 |
パス | string , 以下にマッチ ^r[a-z0-9]{26}$ |
application/json
レコードが更新されました。レスポンス本体は、更新されたレコードです。
幾つかのパラメーターが不正です。
ユーザー認証に失敗しました。
リクエストが許可されていません。
幾つかのリソースが見つかりませんでした。
リクエスト数の制限に達しました。
サーバー上で問題が発生しました。
| Bearer | |
| Basic |
ユーザーのリストを名前順に取得します。/{applicationId}/usersよりも詳細な情報が取得できます。
| applicationId | アプリケーションのID。 |
パス | string , 以下にマッチ ^p[a-z0-9]{26}$ | |
| skip | 読み飛ばすユーザーの数。 |
クエリパラメーター | integer | |
| limit | 取得するユーザー数。 |
クエリパラメーター | integer , { x ∈ ℤ | x ≤ 100 } 100 | |
| search | 検索条件。指定した文字列を名前、メールアドレス、プロファイル名、チーム名(存在する場合)に含むユーザーがマッチします。大文字小文字を区別します。 |
クエリパラメーター | string |
application/json
ユーザーのリストを取得しました。レスポンス本体は、取得したユーザーの配列です。
幾つかのパラメーターが不正です。
ユーザー認証に失敗しました。
リクエストが許可されていません。
幾つかのリソースが見つかりませんでした。
リクエスト数の制限に達しました。
サーバー上で問題が発生しました。
| Bearer | |
| Basic |
ユーザーを作成します。共通ユーザーモードが有効な場合は、指定されたアプリケーションで共通ユーザーを有効にします。
application/json
リクエスト本体には、ユーザーを作成するためのパラメーターをJSONオブジェクト形式で指定します。
ユーザーを作成するためのパラメーターを含むオブジェクト。
{
"admin": false,
"apiAccess": true,
"email": "user1@example.com",
"managementApiAccess": false,
"name": "user1",
"password": "Password1",
"profile": {
"name": "デフォルト"
},
"team": {
"name": "デフォルト"
},
"teamLeader": false
}
作成するユーザーの名前。共通ユーザーモードが有効な場合は、存在する共通ユーザーの名前を指定します。共通ユーザーモードが無効な場合は、任意の有効なユーザー名を指定できます。このプロパティには、1文字以上64文字以下で、「_」から始まらない文字列を指定してください。
作成するユーザーのメールアドレス。共通ユーザーモードが有効な場合にこのパラメーターを渡すと、リクエストが失敗します。共通ユーザーモードが無効な場合は必須です。
作成するユーザーのパスワード。共通ユーザーモードが有効な場合にこのパラメーターを渡すと、リクエストが失敗します。共通ユーザーモードが無効な場合は必須です。このプロパティには、8文字以上の、小文字、大文字、数字をすべて1文字以上含む文字列を指定します。
ユーザーが管理者かどうかを指定するフラグ。
ユーザーがPlatio APIを使えるかどうかを指定するフラグ。
ユーザーが管理APIを使えるかどうかを指定するフラグ。trueを指定するときは、apiAccessもtrueである必要があります。
ユーザーに割り当てるプロファイル。
ユーザーに割り当てるチーム。チームモードが有効な場合は必須です。チームモードが無効な場合にこのパラメーターを指定すると、リクエストが失敗します。
ユーザーがチームリーダーかどうかを指定するフラグ。チームモードが有効な場合は必須です。チームモードが無効な場合にこのパラメーターを渡すと、リクエストが失敗します。
| applicationId | アプリケーションのID。 |
パス | string , 以下にマッチ ^p[a-z0-9]{26}$ | |
| userId | ユーザーのID。 |
パス | object , 以下にマッチ ^u[a-z0-9]{7}$ |
application/json
ユーザーが作成されました。レスポンスの本体は、作成されたユーザーです。
幾つかのパラメーターが不正です。
ユーザー認証に失敗しました。
リクエストが許可されていません。
リクエスト数の制限に達しました。
サーバー上で問題が発生しました。
| Bearer | |
| Basic |
指定されたユーザーを削除します。共通ユーザーモードが有効な場合には使用できません。
| applicationId | アプリケーションのID。 |
パス | string , 以下にマッチ ^p[a-z0-9]{26}$ | |
| userId | ユーザーのID。 |
パス | object |
ユーザーが削除されました。
幾つかのパラメーターが不正です。
ユーザー認証に失敗しました。
リクエストが許可されていません。
指定されたユーザーが見つかりませんでした。
共通ユーザーモードが有効です。
リクエスト数の制限に達しました。
サーバー上で問題が発生しました。
| Bearer | |
| Basic |
指定されたユーザーを取得します。/{applicationId}/usersよりも詳細な情報が取得できます。
| applicationId | アプリケーションのID。 |
パス | object | |
| userId | ユーザーのID。 |
パス | string , 以下にマッチ ^u[a-z0-9]{7}$ |
application/json
ユーザーを取得しました。レスポンス本体は、取得したユーザーです。
幾つかのパラメーターが不正です。
ユーザー認証に失敗しました。
リクエストが許可されていません。
指定されたユーザーが見つかりませんでした。
リクエスト数の制限に達しました。
サーバー上で問題が発生しました。
| Bearer | |
| Basic |
指定されたユーザーを更新します。
application/json
リクエスト本体には、ユーザーを更新するためのパラメーターをJSONオブジェクト形式で指定します。
ユーザーを更新するためのパラメーターを含むオブジェクト。
{
"admin": false,
"apiAccess": true,
"disabled": false,
"email": "new-email@example.com",
"managementApiAccess": false,
"password": "NewPassword1",
"profile": {
"name": "デフォルト"
},
"team": {
"name": "デフォルト"
},
"teamLeader": false
}
ユーザーのメールアドレス。共通ユーザーモードが有効な場合にこのパラメーターを指定すると、リクエストが失敗します。共通ユーザーモードが無効な場合は必須です。
ユーザーのパスワード。共通ユーザーモードが有効な場合にこのパラメーターを指定すると、リクエストが失敗します。
ユーザーが管理者かどうかを指定するフラグ。
ユーザーがPlatio APIを使えるかどうかを指定するフラグ。
ユーザーが管理APIを使えるかどうかを指定するフラグ。trueを指定するときは、apiAccessもtrueである必要があります。
ユーザーに割り当てるプロファイル。
ユーザーに割り当てるチーム。チームモードが有効な場合は必須です。チームモードが無効な場合にこのパラメーターを指定すると、リクエストが失敗します。
ユーザーがチームリーダーかどうかを指定するフラグ。チームモードが有効な場合は必須です。チームモードが無効な場合にこのパラメーターを渡すと、リクエストが失敗します。
ユーザーの有効・無効を指定するフラグ。ユーザーを無効にすると、アプリケーションにログインできなくなります。
| applicationId | アプリケーションのID。 |
パス | string , 以下にマッチ ^p[a-z0-9]{26}$ | |
| userId | ユーザーのID。 |
パス | string , 以下にマッチ ^u[a-z0-9]{7}$ |
application/json
ユーザーが更新されました。レスポンス本体は、更新されたユーザーです。
幾つかのパラメーターが不正です。
ユーザー認証に失敗しました。
リクエストが許可されていません。
指定されたユーザーが見つかりませんでした。
リクエスト数の制限に達しました。
サーバー上で問題が発生しました。
| Bearer | |
| Basic |
ユーザーのリストを名前順に取得します。
| applicationId | アプリケーションのID。 |
パス | string , 以下にマッチ ^p[a-z0-9]{26}$ | |
| skip | 読み飛ばすユーザーの数。 |
クエリパラメーター | integer | |
| limit | 取得するユーザー数。 |
クエリパラメーター | integer , { x ∈ ℤ | x ≤ 100 } 100 | |
| search | 検索条件。指定した文字列を名前に含むユーザーがマッチします。大文字小文字を区別します。 |
クエリパラメーター | string |
application/json
ユーザーのリストを取得しました。レスポンス本体は、取得したユーザーの配列です。
幾つかのパラメーターが不正です。
ユーザー認証に失敗しました。
リクエストが許可されていません。
幾つかのリソースが見つかりませんでした。
リクエスト数の制限に達しました。
サーバー上で問題が発生しました。
| Bearer | |
| Basic |
ユーザーにプッシュ通知を送ります。プッシュ通知を送るには、アプリケーションの設定でプッシュ通知を有効にする必要があります。また、ミニアプリの管理者ユーザーのみがプッシュ通知を送ることができます。
リクエスト本体には、通知を送るためのパラメーターをJSON形式で指定します。
通知を送るためのパラメーターを含むオブジェクト。
{
"body": "温度が高すぎます。",
"sound": "default",
"title": "警告!"
}
通知のタイトル
通知の本文
ユーザーが通知をタップした時に開くURL。Platio URLを使用して、データポケットやレコードを開くこともできます。詳細は、 https://doc.plat.io/api/ja/url.html を参照してください。
音を鳴らす場合には、defaultを指定します。空文字列を指定した場合、もしくはこのプロパティを指定しない場合には、音は鳴りません。
| applicationId | アプリケーションのID。 |
パス | string , 以下にマッチ ^p[a-z0-9]{26}$ | |
| userId | ユーザーのID。 |
パス | string , 以下にマッチ ^u[a-z0-9]{7}$ |
application/json
ユーザーに通知を送りました。ユーザーがPlatioアプリの通知を受け取る許可を与えていない場合、通知が受け取られない可能性があります。
幾つかのパラメーターが不正です。
ユーザー認証に失敗しました。
リクエストが許可されていません。
幾つかのリソースが見つかりませんでした。
リクエスト数の制限に達しました。
サーバー上で問題が発生しました。
| Bearer | |
| Basic |
{
"collections": [
{
"columns": [
{
"id": "c785eb1d",
"name": "Name",
"searchable": true,
"sortable": true,
"type": "String",
"unique": true
},
{
"id": "cda200dd",
"name": "Image",
"searchable": false,
"sortable": false,
"type": "Attachment",
"unique": false
}
],
"id": "t3ec0e55",
"name": "Author",
"readAccessType": "everyone",
"writeAccessType": "creatorOnly"
},
{
"columns": [
{
"id": "ce5ca799",
"name": "ID",
"searchable": true,
"sortable": false,
"type": "Number",
"unique": true
},
{
"id": "c45870e3",
"name": "Title",
"searchable": true,
"sortable": true,
"type": "String",
"unique": false
},
{
"id": "cf8fe3f1",
"name": "Reference Author Name",
"scheme": {
"collectionId": "t3ec0e55",
"columnId": "c785eb1d"
},
"searchable": true,
"sortable": true,
"type": "ReferenceString",
"unique": false
}
],
"id": "t4395e79",
"name": "Book",
"readAccessType": "everyone",
"writeAccessType": "everyone"
}
],
"id": "pahmahtftzbhmdpu2eim3xytzdy",
"name": "Library",
"sharedUsersModeEnabled": false,
"teamsModeEnabled": false,
"url": "https://app.plat.io/app/Demo/Library",
"version": 14
}
アプリケーションのID。
アプリケーションの名前。
アプリケーションのバージョン。
アプリケーションで共通ユーザーモードが有効かどうかを指定するフラグ。
アプリケーションでチームモードが有効かどうかを指定するフラグ。
アプリケーションのURL。
コレクションのリスト。
{
"contentType": "image/jpeg",
"id": "amghzojy2nfctzmqy43aflu3xpe",
"name": "image.jpg",
"size": 4151345
}
添付ファイルのID。
添付ファイルの名前。
添付ファイルのContent-Type。
添付ファイルのサイズ。
{
"columns": [
{
"id": "c785eb1d",
"name": "Name",
"searchable": true,
"sortable": true,
"type": "String",
"unique": false
},
{
"id": "cda200dd",
"name": "Image",
"searchable": false,
"sortable": false,
"type": "Attachment",
"unique": false
},
{
"id": "c4127d81",
"name": "Accelerometer (BlueNinja)",
"scheme": {
"keys": [
{
"name": "x",
"type": "Number"
},
{
"name": "y",
"type": "Number"
},
{
"name": "z",
"type": "Number"
}
]
},
"searchable": false,
"sortable": false,
"type": "Object",
"unique": false
}
],
"id": "t3ec0e55",
"name": "Collection 1",
"readAccessType": "everyone",
"writeAccessType": "creatorOnly"
}
コレクションのID。
コレクションの名前。
コレクションの読み取りアクセスタイプ。
コレクションの書き込みアクセスタイプ。
カラムのリスト。
{
"id": "c785eb1d",
"name": "Name",
"searchable": true,
"sortable": true,
"type": "String",
"unique": false
}
カラムのID。
カラムの名前。
カラムの型。詳細については、 https://doc.plat.io/api/ja/values.html を参照してください。
カラムのスキーマ。カラムの型が参照系の場合には、collectionIdとcolumnIdプロパティを持ちます。Object型の場合には、keysプロパティを持ちます。keysプロパティは配列で、各アイテムは、nameとtypeプロパティを持つオブジェクトです。Array型の場合には、elementプロパティを持ちます。elementプロパティは、typeプロパティと、オプションでschemeプロパティを持ちます。それ以外の型の場合には、このプロパティは含まれません。詳細については、 https://doc.plat.io/api/ja/values.html を参照してください。
このカラムの値がコレクションの中で一意である必要がある場合にはtrue、それ以外の場合にはfalse。
レコードがこのカラムの値でソートできる場合にはtrue、それ以外の場合にはfalse。
レコードがこのカラムの値で検索できる場合にはtrue、それ以外の場合にはfalse。
{
"code": "INVALID_APPLICATION_ID"
}
エラーコード。
エラーに関する追加の情報。
{
"admin": false,
"apiAccess": true,
"disabled": false,
"email": "user1@example.com",
"id": "u1a2b3c4",
"managementApiAccess": true,
"name": "user1",
"profile": {
"name": "Profile 1"
},
"team": {
"name": "Team A"
},
"teamLeader": true
}
ユーザーのID。
ユーザーの名前。
ユーザーのメールアドレス。
ユーザーが管理者かどうかを指定するフラグ。
ユーザーがPlatio APIを使えるかどうかを指定するフラグ。
ユーザーが管理APIを使えるかどうかを指定するフラグ。
ユーザーのプロファイル。
プロファイルの名前。
ユーザーのチーム。 チームモードが有効な場合にのみ存在します。
チームの名前。
ユーザーがチームリーダーかどうかを指定するフラグ。チームモードが有効な場合にのみ存在します。
ユーザーの有効・無効を指定するフラグ。
{
"createdAt": "2017-03-13T02:18:14.500Z",
"createdBy": {
"id": "u11bbc2c",
"name": "user1"
},
"hash": "10dd94a465266c4cd0bca9e1481845d9b9074b42",
"id": "rwyfzcbdj2vb5rbsebyp3f42zvi",
"timestamp": "2017-03-13T02:18:14.519Z",
"updatedAt": "2017-03-13T02:18:14.500Z",
"updatedBy": {
"id": "u11bbc2c",
"name": "user1"
},
"values": {
"c88a7152": {
"type": "Number",
"value": 124356
},
"cc864ba9": {
"type": "String",
"value": "string value"
}
}
}
レコードのID。
カラムIDから値へのマッピング。レコードを取得した時に、カラムに値が指定されていない場合には、そのカラムのIDは含まれません。
レコードのハッシュ。
レコードのタイムスタンプ。
レコードの作成日時。
レコードの作成者。
レコードの更新日時。
レコードの更新日時。