Platio API リファレンス

バージョン: 1

スキーマ: https

概要

タグ: レコード

操作 説明
GET /{applicationId}/collections/{collectionId}/records

レコードのリストを取得

POST /{applicationId}/collections/{collectionId}/records

レコードを作成

PUT /{applicationId}/collections/{collectionId}/records

複数のレコードを更新

DELETE /{applicationId}/collections/{collectionId}/records

複数のレコードを削除

PATCH /{applicationId}/collections/{collectionId}/records/upsert/{upsertKeyColumnId}

レコードをUpsert

GET /{applicationId}/collections/{collectionId}/records/{recordId}

レコードの取得

PUT /{applicationId}/collections/{collectionId}/records/{recordId}

レコードを更新

DELETE /{applicationId}/collections/{collectionId}/records/{recordId}

レコードを削除

タグ: 添付ファイル

操作 説明
POST /{applicationId}/collections/{collectionId}/attachments

添付ファイルを作成

GET /{applicationId}/collections/{collectionId}/attachments/{attachmentId}

添付ファイルを取得

タグ: ユーザー

操作 説明
GET /{applicationId}/users

ユーザーのリストを取得

POST /{applicationId}/users/{userId}/notifications

プッシュ通知を送信

タグ: 定義

操作 説明
GET /{applicationId}

アプリケーション定義を取得

セキュリティ

Bearer

Type: Bearer
説明:

Bearer認証。トークンIDと秘密トークンを.で繋いだものを、Bearerトークンとして使用します。

Basic

タイプ: ベーシック認証
説明:

ベーシック認証。あなたのユーザーIDをユーザ名として、あなたのパスワードをパスワードとして使用します。

パス

アプリケーション定義を取得

GET /{applicationId}

タグ: 定義

アプリケーションの定義を、コレクション・カラムの定義とともに取得します。

applicationId

アプリケーションのID。

パス string , 以下にマッチ ^p[a-z0-9]{26}$

application/json

200 OK

アプリケーション定義を取得しました。レスポンス本体は、取得したアプリケーション定義です。

400 Bad Request

幾つかのパラメーターが不正です。

401 Unauthorized

ユーザー認証に失敗しました。

403 Forbidden

リクエストが許可されていません。

404 Not Found

幾つかのリソースが見つかりませんでした。

429 Too Many Requests

リクエスト数の制限に達しました。

500 Internal Server Error

サーバー上で問題が発生しました。

Bearer
Basic
添付ファイルを作成

POST /{applicationId}/collections/{collectionId}/attachments

タグ: 添付ファイル

指定されたコレクションに添付ファイルを作成します。

*/*

リクエスト本体には、添付ファイルのバイナリストリームを渡します。

添付ファイルのバイナリストリーム。

applicationId

アプリケーションのID。

パス string , 以下にマッチ ^p[a-z0-9]{26}$
collectionId

コレクションのID。

パス string , 以下にマッチ ^t[a-z0-9]{7}$
Content-Disposition

添付ファイルのContent-Disposition。filenameパラメーターの値が添付ファイルの名前になります。指定されない場合には、'Unknonwn'になります。

ヘッダー string
Content-Type

添付ファイルのContent-Type。任意のContent-Typeが指定できます。指定されない場合には、application/octet-streamになります。

ヘッダー string application/octet-stream
X-Platio-CreatorId

添付ファイルの作成者のユーザーID。このパラメーターを指定するには、あなたが管理者ユーザーである必要があります。指定しない場合、あなたが作成者になります。

ヘッダー string , 以下にマッチ ^u[a-z0-9]{7}$

application/json

200 OK

添付ファイルが作成されました。レスポンス本体は、作成された添付ファイルのメタデータです。

400 Bad Request

幾つかのパラメーターが不正です。

401 Unauthorized

ユーザー認証に失敗しました。

403 Forbidden

リクエストが許可されていません。

404 Not Found

幾つかのリソースが見つかりませんでした。

429 Too Many Requests

リクエスト数の制限に達しました。

500 Internal Server Error

サーバー上で問題が発生しました。

Bearer
Basic
添付ファイルを取得

GET /{applicationId}/collections/{collectionId}/attachments/{attachmentId}

タグ: 添付ファイル

指定された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}$

*/*

200 OK

添付ファイルを取得しました。レスポンス本体は、添付ファイルのバイナリストリームです。

Cache-Control string
ETag string
Last-Modified string
Content-Type string
Content-Disposition string
304 Not Modified

添付ファイルは変更されていません。

400 Bad Request

幾つかのパラメーターが不正です。

401 Unauthorized

ユーザー認証に失敗しました。

403 Forbidden

リクエストが許可されていません。

404 Not Found

幾つかのリソースが見つかりませんでした。

429 Too Many Requests

リクエスト数の制限に達しました。

500 Internal Server Error

サーバー上で問題が発生しました。

Bearer
Basic
複数のレコードを削除

DELETE /{applicationId}/collections/{collectionId}/records

タグ: レコード

指定されたコレクションのレコードを削除します。パラメーターの指定により、どのレコードを削除するかを指定することができます。

applicationId

アプリケーションのID。

パス string , 以下にマッチ ^p[a-z0-9]{26}$
collectionId

コレクションのID。

パス string , 以下にマッチ ^t[a-z0-9]{7}$
search

検索条件。例えば、Age:31 "John" $to:2017-03-16。詳細については、 https://doc.plat.io/api/ja/search.html を参照してください。

クエリパラメーター string
timezone

検索条件内で指定された日時のタイムゾーン。例えば、Asia/Tokyo

クエリパラメーター string アプリケーションのタイムゾーン
limit

削除するレコードの最大数。

クエリパラメーター integer , { x ∈ ℤ | x ≤ 100000 } 100000
200 OK

レコードが削除されました (limitを指定した場合)。

{
"deletedCount": 3453
}
deletedCount: number

削除されたレコードの数。

204 No Content

レコードが削除されました (limitを指定しない場合)。

400 Bad Request

幾つかのパラメーターが不正です。

401 Unauthorized

ユーザー認証に失敗しました。

403 Forbidden

リクエストが許可されていません。

404 Not Found

幾つかのリソースが見つかりませんでした。

429 Too Many Requests

リクエスト数の制限に達しました。

500 Internal Server Error

サーバー上で問題が発生しました。

Bearer
Basic
レコードのリストを取得

GET /{applicationId}/collections/{collectionId}/records

タグ: レコード

指定されたコレクションのレコードのリストを取得します。パラメーターの指定により、どのレコードを取得するかを指定することができます。

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。sortKeycolumnのときには必須です。その他の場合には無視されます。指定されたカラムはソート可能である必要があります。

クエリパラメーター string , 以下にマッチ ^c[a-z0-9]{7}$
search

検索条件。例えば、Age:31 "John" $to:2017-03-16。詳細については、 https://doc.plat.io/api/ja/search.html を参照してください。

クエリパラメーター string
timezone

検索条件内で指定された日時のタイムゾーン。例えば、Asia/Tokyo

クエリパラメーター string アプリケーションのタイムゾーン

application/json

200 OK

レコードのリストを取得しました。レスポンス本体は、取得したレコードの配列です。

400 Bad Request

幾つかのパラメーターが不正です。

401 Unauthorized

ユーザー認証に失敗しました。

403 Forbidden

リクエストが許可されていません。

404 Not Found

幾つかのリソースが見つかりませんでした。

429 Too Many Requests

リクエスト数の制限に達しました。

500 Internal Server Error

サーバー上で問題が発生しました。

Bearer
Basic
レコードを作成

POST /{applicationId}/collections/{collectionId}/records

タグ: レコード

指定した値を使用して、指定したコレクションにレコードを作成します。

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"
}
}
}
values: object

カラムIDから値へのマッピング。詳細については、 https://doc.plat.io/api/ja/values.html を参照してください。

creatorId: string , 以下にマッチ ^u[a-z0-9]{7}$

レコードの作成者のユーザーID。このパラメーターを指定するには、あなたが管理者ユーザーである必要があります。指定しない場合、あなたが作成者になります。

applicationId

アプリケーションのID。

パス string , 以下にマッチ ^p[a-z0-9]{26}$
collectionId

コレクションのID。

パス string , 以下にマッチ ^t[a-z0-9]{7}$

application/json

200 OK

レコードが作成されました。レスポンス本体は、作成されたレコードです。

400 Bad Request

幾つかのパラメーターが不正です。

401 Unauthorized

ユーザー認証に失敗しました。

403 Forbidden

リクエストが許可されていません。

404 Not Found

幾つかのリソースが見つかりませんでした。

429 Too Many Requests

リクエスト数の制限に達しました。

500 Internal Server Error

サーバー上で問題が発生しました。

Bearer
Basic
複数のレコードを更新

PUT /{applicationId}/collections/{collectionId}/records

タグ: レコード

指定した値を使用して、指定されたコレクションの複数のレコードを更新します。

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"
}
}
}
]
object
id: string , 以下にマッチ ^r[a-z0-9]{26}$

レコードのID。

values: object

カラムIDから値へのマッピング。詳細については、 https://doc.plat.io/api/ja/values.html を参照してください。

replace: boolean true

全ての値を置き換えるかどうかを指定するフラグ。falseを指定すると、valuesで指定された値のみを更新します。値を削除するには、valuesの対応する値にnullを指定します。trueまたは指定しない場合には、全ての値を更新します。

applicationId

アプリケーションのID。

パス string , 以下にマッチ ^p[a-z0-9]{26}$
collectionId

コレクションのID。

パス string , 以下にマッチ ^t[a-z0-9]{7}$

application/json

200 OK

複数のレコードが更新されました。レスポンス本体は、更新されたレコードの配列です。

400 Bad Request

幾つかのパラメーターが不正です。

401 Unauthorized

ユーザー認証に失敗しました。

403 Forbidden

リクエストが許可されていません。

404 Not Found

幾つかのリソースが見つかりませんでした。

429 Too Many Requests

リクエスト数の制限に達しました。

500 Internal Server Error

サーバー上で問題が発生しました。

Bearer
Basic
レコードをUpsert

PATCH /{applicationId}/collections/{collectionId}/records/upsert/{upsertKeyColumnId}

タグ: レコード

指定したカラムの値が同じレコードを更新します。レコードが見つからなかった場合には、新しいレコードを作成します。

リクエスト本体には、レコードを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

200 OK

レコードがUpsertされました。レスポンス本体は、Upsertされたレコードです。

400 Bad Request

幾つかのパラメーターが不正です。

401 Unauthorized

ユーザー認証に失敗しました。

403 Forbidden

リクエストが許可されていません。

404 Not Found

幾つかのリソースが見つかりませんでした。

429 Too Many Requests

リクエスト数の制限に達しました。

500 Internal Server Error

サーバー上で問題が発生しました。

Bearer
Basic
レコードを削除

DELETE /{applicationId}/collections/{collectionId}/records/{recordId}

タグ: レコード

指定されたレコードを削除します。

applicationId

アプリケーションのID。

パス string , 以下にマッチ ^p[a-z0-9]{26}$
collectionId

コレクションのID。

パス string , 以下にマッチ ^t[a-z0-9]{7}$
recordId

レコードのID。

パス string , 以下にマッチ ^r[a-z0-9]{26}$
204 No Content

レコードが削除されました。

400 Bad Request

幾つかのパラメーターが不正です。

401 Unauthorized

ユーザー認証に失敗しました。

403 Forbidden

リクエストが許可されていません。

404 Not Found

幾つかのリソースが見つかりませんでした。

429 Too Many Requests

リクエスト数の制限に達しました。

500 Internal Server Error

サーバー上で問題が発生しました。

Bearer
Basic
レコードの取得

GET /{applicationId}/collections/{collectionId}/records/{recordId}

タグ: レコード

指定されたコレクションにある、指定された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

200 OK

レコードを取得しました。レスポンス本体は、取得したレコードです。

400 Bad Request

幾つかのパラメーターが不正です。

401 Unauthorized

ユーザー認証に失敗しました。

403 Forbidden

リクエストが許可されていません。

404 Not Found

幾つかのリソースが見つかりませんでした。

429 Too Many Requests

リクエスト数の制限に達しました。

500 Internal Server Error

サーバー上で問題が発生しました。

Bearer
Basic
レコードを更新

PUT /{applicationId}/collections/{collectionId}/records/{recordId}

タグ: レコード

指定した値を使用して、指定されたレコードを更新します。

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"
}
}
}
values: object

カラムIDから値へのマッピング。詳細については、 https://doc.plat.io/api/ja/values.html を参照してください。

replace: boolean true

全ての値を置き換えるかどうかを指定するフラグ。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

200 OK

レコードが更新されました。レスポンス本体は、更新されたレコードです。

400 Bad Request

幾つかのパラメーターが不正です。

401 Unauthorized

ユーザー認証に失敗しました。

403 Forbidden

リクエストが許可されていません。

404 Not Found

幾つかのリソースが見つかりませんでした。

429 Too Many Requests

リクエスト数の制限に達しました。

500 Internal Server Error

サーバー上で問題が発生しました。

Bearer
Basic
ユーザーのリストを取得

GET /{applicationId}/users

タグ: ユーザー

ユーザーのリストを名前順に取得します。

applicationId

アプリケーションのID。

パス string , 以下にマッチ ^p[a-z0-9]{26}$
skip

読み飛ばすユーザーの数。

クエリパラメーター integer
limit

取得するユーザー数。

クエリパラメーター integer , { x ∈ ℤ | x ≤ 100 } 100
search

検索条件。指定した文字列を名前に含むユーザーがマッチします。大文字小文字を区別します。

クエリパラメーター string

application/json

200 OK

ユーザーのリストを取得しました。レスポンス本体は、取得したユーザーの配列です。

400 Bad Request

幾つかのパラメーターが不正です。

401 Unauthorized

ユーザー認証に失敗しました。

403 Forbidden

リクエストが許可されていません。

404 Not Found

幾つかのリソースが見つかりませんでした。

429 Too Many Requests

リクエスト数の制限に達しました。

500 Internal Server Error

サーバー上で問題が発生しました。

Bearer
Basic
プッシュ通知を送信

POST /{applicationId}/users/{userId}/notifications

タグ: ユーザー

ユーザーにプッシュ通知を送ります。プッシュ通知を送るには、アプリケーションの設定でプッシュ通知を有効にする必要があります。また、ミニアプリの管理者ユーザーのみがプッシュ通知を送ることができます。

リクエスト本体には、通知を送るためのパラメーターをJSON形式で指定します。

通知を送るためのパラメーターを含むオブジェクト。

{
"body": "温度が高すぎます。",
"sound": "default",
"title": "警告!"
}
title: string (128文字以下)

通知のタイトル

body: string (512文字以下)

通知の本文

url: string (1024文字以下)

ユーザーが通知をタップした時に開くURL。Platio URLを使用して、データポケットやレコードを開くこともできます。詳細は、 https://doc.plat.io/api/ja/url.html を参照してください。

sound: string

音を鳴らす場合には、defaultを指定します。空文字列を指定した場合、もしくはこのプロパティを指定しない場合には、音は鳴りません。

applicationId

アプリケーションのID。

パス string , 以下にマッチ ^p[a-z0-9]{26}$
userId

ユーザーのID。

パス string , 以下にマッチ ^u[a-z0-9]{7}$

application/json

204 No Content

ユーザーに通知を送りました。ユーザーがPlatioアプリの通知を受け取る許可を与えていない場合、通知が受け取られない可能性があります。

400 Bad Request

幾つかのパラメーターが不正です。

401 Unauthorized

ユーザー認証に失敗しました。

403 Forbidden

リクエストが許可されていません。

404 Not Found

幾つかのリソースが見つかりませんでした。

429 Too Many Requests

リクエスト数の制限に達しました。

500 Internal Server Error

サーバー上で問題が発生しました。

Bearer
Basic

スキーマ定義

Application: object

{
"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",
"url": "https://app.plat.io/app/Demo/Library",
"version": 14
}
id: string , 以下にマッチ ^p[a-z0-9]{26}$

アプリケーションのID。

name: string

アプリケーションの名前。

version: integer

アプリケーションのバージョン。

url: string

アプリケーションのURL。

collections: object[]

コレクションのリスト。

Attachment: object

{
"contentType": "image/jpeg",
"id": "amghzojy2nfctzmqy43aflu3xpe",
"name": "image.jpg",
"size": 4151345
}
id: string , 以下にマッチ ^a[a-z0-9]{26}$

添付ファイルのID。

name: string

添付ファイルの名前。

contentType: string

添付ファイルのContent-Type。

size: integer

添付ファイルのサイズ。

Collection: object

{
"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: string , 以下にマッチ ^t[a-z0-9]{7}$

コレクションのID。

name: string

コレクションの名前。

readAccessType: string , x ∈ { everyone , creatorOnly }

コレクションの読み取りアクセスタイプ。

writeAccessType: string , x ∈ { everyone , creatorOnly }

コレクションの書き込みアクセスタイプ。

columns: object[]

カラムのリスト。

Column: object

{
"id": "c785eb1d",
"name": "Name",
"searchable": true,
"sortable": true,
"type": "String",
"unique": false
}
id: string , 以下にマッチ ^t[a-z0-9]{7}$

カラムのID。

name: string

カラムの名前。

type: string

カラムの型。詳細については、 https://doc.plat.io/api/ja/values.html を参照してください。

scheme: object

カラムのスキーマ。カラムの型が参照系の場合には、collectionIdcolumnIdプロパティを持ちます。Object型の場合には、keysプロパティを持ちます。keysプロパティは配列で、各アイテムは、nametypeプロパティを持つオブジェクトです。Array型の場合には、elementプロパティを持ちます。elementプロパティは、typeプロパティと、オプションでschemeプロパティを持ちます。それ以外の型の場合には、このプロパティは含まれません。詳細については、 https://doc.plat.io/api/ja/values.html を参照してください。

unique: boolean

このカラムの値がコレクションの中で一意である必要がある場合にはtrue、それ以外の場合にはfalse

sortable: boolean

レコードがこのカラムの値でソートできる場合にはtrue、それ以外の場合にはfalse

searchable: boolean

レコードがこのカラムの値で検索できる場合にはtrue、それ以外の場合にはfalse

ErrorResponse: object

{
"code": "INVALID_APPLICATION_ID"
}
code: string

エラーコード。

params: object

エラーに関する追加の情報。

Record: object

{
"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: string , 以下にマッチ ^r[a-z0-9]{26}$

レコードのID。

values: object

カラムIDから値へのマッピング。

hash: string

レコードのハッシュ。

timestamp: string フォーマット: YYYY-DD-MM'T'hh:mm:ss.sss'Z'

レコードのタイムスタンプ。

createdAt: string フォーマット: YYYY-DD-MM'T'hh:mm:ss.sss'Z'

レコードの作成日時。

createdBy: User

レコードの作成者。

updatedAt: string フォーマット: YYYY-DD-MM'T'hh:mm:ss.sss'Z'

レコードの更新日時。

updatedBy: User

レコードの更新日時。

User: object

{
"id": "u11bbc2c",
"name": "user 1"
}
id: string , 以下にマッチ ^u[a-z0-9]{7}$

ユーザーのID。

name: string

ユーザーの名前。